Skip to content

docs(agents): forbid attributing changes to requests - #279

Merged
amirhs1 merged 1 commit into
mainfrom
docs/attribution-rule
Nov 18, 2026
Merged

amirhs1 merged 1 commit into
mainfrom
docs/attribution-rule

Conversation

@amirhs1

@amirhs1 amirhs1 commented Nov 18, 2026

Copy link
Copy Markdown
Owner

Summary

AGENTS.md, "Do not", gains one bullet: a commit, pull request, issue, or
comment 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.md has 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 the
    reason for a change. The wording was supplied and is entered unchanged,
    wrapped to the file's width.

Checks run

  • git diff --check → no output
  • python -m flake8 polyphys → exit 0
  • python -m mypy polyphys/analyze polyphys/manage polyphys/probe polyphys/simulate
    → Success: no issues found in 25 source files
  • python -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:cacheprovider and the XML report written outside the
    worktree → 2065 passed, 2 skipped in 45.36s

Not verified: python -m build and the Sphinx build, not run because no
packaging file or docs/source/ changed; CI, pending on this pull request.

  • python -m flake8 polyphys
  • python -m mypy polyphys/analyze polyphys/manage polyphys/probe polyphys/simulate
  • python -m pytest polyphys README.md --cov=polyphys --cov-report=term-missing --cov-report=xml --doctest-modules --doctest-glob='README.md'
  • python -m build if packaging metadata, package data, or package layout changed
  • python -m sphinx -W -b html docs/source docs/_build if docs/source/ changed
  • CHANGELOG.md has 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

  • Measurement and statistics behavior is unchanged, or the change is explained above with how it was validated
  • Units, numerical fixtures, and domain assumptions are preserved or explained
  • Parser lineage and organizer vocabulary are unchanged, or matching parser tests/docs were updated

The change touches AGENTS.md only; no package code changed.

Decisions and risks

  • Undoing it: revert the one commit; nothing depends on it.
  • It affects agents that write commits, pull requests, issues, or comments
    here.
  • It changes no numerical result, stored artifact, file name, or file format.

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 the
reason 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

- 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
@amirhs1 amirhs1 added type:docs Type: docs area:agents Area: agents labels Nov 18, 2026
@codecov

codecov Bot commented Nov 18, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.95%. Comparing base (be675d5) to head (22b155b).

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@amirhs1
amirhs1 marked this pull request as ready for review November 18, 2026 20:39
@amirhs1
amirhs1 merged commit 7132317 into main Nov 18, 2026
13 checks passed
@amirhs1
amirhs1 deleted the docs/attribution-rule branch November 18, 2026 20:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:agents Area: agents type:docs Type: docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant