Add an AGENTS.md file to help with AI-assisted debugging/development

In this time and age, AI is everywhere. However, it's sometimes not very
easy to use. For green-field projects it works quite a bit better than
for existing legacy projects. And Git's source code is _quite_ as legacy
code as they come... 😁

Now, the only way how AI can be used efficiently with legacy code
is by providing enough information by way of prompt context for the
AI to have a chance to make any sense of the code. The structure and
the architecture is, after all, not designed for AI, but rather the
opposite: By virtue of having grown organically over two decades, there
is no design that AI coding models would readily grasp.

So here is a document that describes all kinds of aspects about this
project. The idea is to help AI by providing information that it does
not have ingrained in its weights. The idea is to provide information
that a human prompter might take for granted, but no coding model will
have been trained on specifically.

Assisted-by: Claude Opus 4.5
Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
This commit is contained in:
Johannes Schindelin
2026-01-26 19:18:40 +01:00
committed by Git for Windows Build Agent
parent aad512be1a
commit fbf6dbb539
2 changed files with 1205 additions and 0 deletions

1
.gitattributes vendored
View File

@@ -7,6 +7,7 @@
*.py text eol=lf diff=python
*.bat text eol=crlf
*.png binary
/AGENTS.md conflict-marker-size=32
CODE_OF_CONDUCT.md -whitespace
/Documentation/**/*.adoc text eol=lf whitespace=trail,space,incomplete
/command-list.txt text eol=lf

1204
AGENTS.md Normal file

File diff suppressed because it is too large Load Diff