Skip to content

Document docs spell check pre-push gate in AGENTS.md - #1693

Merged
bdraco merged 1 commit into
aio-libs:masterfrom
bdraco:agents-doc-spelling
May 17, 2026
Merged

Document docs spell check pre-push gate in AGENTS.md#1693
bdraco merged 1 commit into
aio-libs:masterfrom
bdraco:agents-doc-spelling

Conversation

@bdraco

@bdraco bdraco commented May 17, 2026

Copy link
Copy Markdown
Member

What do these changes do?

Adds a new PR rule to AGENTS.md that documents make doc-spelling as the pre-push gate, mirroring aio-libs/multidict#1345. The new section explains that sphinxcontrib.spelling reads every CHANGES/*.rst fragment, so an unknown technical word in a news fragment fails CI before a human ever sees the PR; the fix is to either add the word to docs/spelling_wordlist.txt in the same commit or correct the typo.

Renumbers the surrounding PR rules (Commit hygiene becomes #7) and adds a matching bullet to Things not to do.

Are there changes in behavior for the user?

No. Docs-only change to the agent-facing contributor notes.

Is it a substantial burden for the maintainers to support this?

No. make doc-spelling is already a CI gate via reusable-linters.yml; this just writes the rule down where agents will read it.

Related issue number

Mirrors aio-libs/multidict#1345.

Checklist

  • I think the code is well written
  • [N/A] Unit tests for the changes exist
  • Documentation reflects the changes
  • [N/A] If you provide code modification, please add yourself to CONTRIBUTORS.txt
  • Add a new news fragment into the CHANGES/ folder

@psf-chronographer psf-chronographer Bot added the bot:chronographer:provided There is a change note present in this PR label May 17, 2026
@codspeed-hq

codspeed-hq Bot commented May 17, 2026

Copy link
Copy Markdown

Merging this PR will not alter performance

✅ 99 untouched benchmarks


Comparing bdraco:agents-doc-spelling (3356871) with master (faaa1fd)1

Open in CodSpeed

Footnotes

  1. No successful run was found on master (255818d) during the generation of this report, so faaa1fd was used instead as the comparison base. There might be some changes unrelated to this pull request in this report.

@bdraco
bdraco marked this pull request as ready for review May 17, 2026 14:50
@bdraco
bdraco merged commit 9a87767 into aio-libs:master May 17, 2026
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bot:chronographer:provided There is a change note present in this PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant