Document docs spell check pre-push gate in AGENTS.md - #1693
Merged
Conversation
bdraco
marked this pull request as ready for review
May 17, 2026 14:50
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.
What do these changes do?
Adds a new PR rule to
AGENTS.mdthat documentsmake doc-spellingas the pre-push gate, mirroring aio-libs/multidict#1345. The new section explains thatsphinxcontrib.spellingreads everyCHANGES/*.rstfragment, 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 todocs/spelling_wordlist.txtin 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-spellingis already a CI gate viareusable-linters.yml; this just writes the rule down where agents will read it.Related issue number
Mirrors aio-libs/multidict#1345.
Checklist
CONTRIBUTORS.txtCHANGES/folder