Skip to content

Add AGENTS.md for MINGW-packages#194

Merged
dscho merged 1 commit intomainfrom
add-an-AGENTS.md-file
Apr 15, 2026
Merged

Add AGENTS.md for MINGW-packages#194
dscho merged 1 commit intomainfrom
add-an-AGENTS.md-file

Conversation

@dscho
Copy link
Copy Markdown
Member

@dscho dscho commented Apr 14, 2026

This adds an AGENTS.md file to help AI tools work effectively with
this repository.

The file serves two purposes. First, it raises the floor for flyby
contributions that use AI. Without guidance, AI-assisted contributions
tend to produce low-quality patches that ignore the project's
conventions and workflows. The AGENTS.md file cannot guarantee good
contributions, but it gives AI tools enough context to produce
something that is at least a reasonable starting point for a human
to refine.

Second, and more importantly, it helps the maintainers of Git for
Windows use AI more effectively for the kind of menial work that does
not require much creativity but is tedious to do by hand. A good
example is the src/playground/ workflow for managing patches: importing
tarballs, applying patches as commits, ensuring stable OIDs so that
format-patch output is reproducible, and re-exporting after amendments.
This is exactly the sort of mechanical, non-trivial work where AI
assistance is valuable, but only if the AI knows the workflow.

The file covers:

  • The relationship between Git for Windows, MSYS2, and the two
    package classes (MSYS vs MINGW)
  • How to invoke makepkg-mingw from PowerShell (including the login
    shell hang trap)
  • Running tests directly from the build directory without rebuilding
  • The Perl $^O situation (cygwin vs msys) and its implications for
    test skip guards and Windows Firewall hangs
  • The full playground workflow for managing patches with stable
    commit OIDs
  • Amending existing patches via amend!/autosquash rather than
    layering new patches

This is adapted from the MSYS2-packages version. The Perl-specific
sections (upgrading Perl, patchprov, DLL/XS version mismatches,
Windows Defender false positives, rebuild lists) were removed since
they are not relevant to MINGW packages. The build instructions were
updated to use makepkg-mingw with MSYSTEM=MINGW64 and the mingw64
toolchain on PATH, and to warn against login shells which hang in
Git for Windows SDK environments.

The playground workflow, updpkgsums/autoCRLF guidance, and general
worktree workflow are retained unchanged.

Assisted-by: Claude Opus 4.6
Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
@dscho dscho self-assigned this Apr 14, 2026
@dscho dscho requested review from mjcheetham and rimrul April 14, 2026 14:54
Copy link
Copy Markdown
Member

@mjcheetham mjcheetham left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@dscho dscho merged commit ea4a94e into main Apr 15, 2026
3 checks passed
@dscho dscho deleted the add-an-AGENTS.md-file branch April 15, 2026 14:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants