Skip to content

Commit b03c608

Browse files
codexByron
authored andcommitted
docs: require underlying motivation in agent-created PRs
The existing `AGENTS.md` guidance requires PRs to describe the problem, but only commit bodies explicitly require motivation. Port the PR motivation requirement from the Gitoxide worktree so reviewers can understand why an agent pursued the work. Require agent-created PR descriptions to identify the underlying motivation, such as the benefiting project or where the bug was discovered. Clarify that restating the fix is insufficient. Validation: reviewed the wording against the Gitoxide requirement and ran `git diff --check`. No tests were run because this changes repository instructions only.
1 parent 8596f2e commit b03c608

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

‎AGENTS.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@ when communicating through a person's account.
99
issue with a fix attached. Do not create an issue solely to follow it immediately
1010
with a PR that fixes it; describe the problem in the PR instead.
1111

12+
Agents creating a PR must state the underlying motivation in its description, such
13+
as the project that will benefit or where the bug was first discovered. Any
14+
motivation is valid; explain why the work was pursued rather than restating what
15+
the PR does. "Want to fix a bug" is insufficient because that is already evident
16+
from the PR itself.
17+
1218
# Gix backend implementations
1319

1420
Gix backend operations must use Gix through the supported GixPython (`gix`)

0 commit comments

Comments
 (0)