Repository navigation
docs(agents): forbid attributing changes to requests - #279
Merged
Merged
Conversation
- Add one bullet to AGENTS.md, "Do not", after the bullet on inventing the reason for a change: a commit, pull request, issue, or comment states what changed, never that someone asked for or approved it, and credits a reporter by linking their issue, pull request, or comment, not by an @-mention. - The bullet's wording was supplied and is entered unchanged, wrapped to the file's width. Why: credit goes by link, not @-mention, because a mention notifies people. Assisted-by: Claude Code, claude-opus-5-5 (transcription) Checks-run: python -m flake8 polyphys — exit 0 Checks-run: python -m mypy, four packages — no issues in 25 files Checks-run: python -m pytest, full gate — 2065 passed, 2 skipped
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #279 +/- ##
=======================================
Coverage 99.95% 99.95%
=======================================
Files 62 62
Lines 10754 10754
=======================================
Hits 10749 10749
Misses 5 5 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
AGENTS.md, "Do not", gains one bullet: a commit, pull request, issue, orcomment states what changed and never attributes the change to someone's
request or approval, and whoever reported a problem or found a bug is credited
by a link to their issue, pull request, or comment, not by an @-mention. Links,
not mentions, because a mention notifies people.
Related issues
None
Problem
AGENTS.mdhas no rule against text such as "as the maintainer asked" or"with the maintainer's approval" in commits, pull requests, issues, and
comments, and none on how to credit someone who reported a problem.
What changed
AGENTS.md:216-219: one bullet, placed after the bullet on inventing thereason for a change. The wording was supplied and is entered unchanged,
wrapped to the file's width.
Checks run
git diff --check→ no outputpython -m flake8 polyphys→ exit 0python -m mypy polyphys/analyze polyphys/manage polyphys/probe polyphys/simulate→
Success: no issues found in 25 source filespython -m pytest polyphys README.md --cov=polyphys --cov-report=term-missing --cov-report=xml --doctest-modules --doctest-glob='README.md',run with
-q -p no:cacheproviderand the XML report written outside theworktree →
2065 passed, 2 skipped in 45.36sNot verified:
python -m buildand the Sphinx build, not run because nopackaging file or
docs/source/changed; CI, pending on this pull request.python -m flake8 polyphyspython -m mypy polyphys/analyze polyphys/manage polyphys/probe polyphys/simulatepython -m pytest polyphys README.md --cov=polyphys --cov-report=term-missing --cov-report=xml --doctest-modules --doctest-glob='README.md'python -m buildif packaging metadata, package data, or package layout changedpython -m sphinx -W -b html docs/source docs/_buildifdocs/source/changedCHANGELOG.mdhas an entry under[Unreleased], or this pull request needs none (CONTRIBUTING.md, "Changelog")The changelog needs no entry: the only area is
agents.Scientific correctness
The change touches
AGENTS.mdonly; no package code changed.Decisions and risks
here.
Notes for review
The bullet is a proposal, for line-by-line review of its wording and its
place in "Do not". It sits beside the
Why:rule, which still records thereason for a change; the new bullet forbids naming who asked for or approved
it.
Assisted-by: Claude Code, claude-opus-5-5 (transcription)
Checks-run: python -m flake8 polyphys — exit 0
Checks-run: python -m mypy, four packages — no issues in 25 files
Checks-run: python -m pytest, full gate — 2065 passed, 2 skipped