Skip to content

add test-first approach to AGENTS.md #2049

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mscuthbert merged 1 commit into from
Sep 30, 2026
+3 −0
Merged

add test-first approach to AGENTS.md #2049

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,9 @@
so an example built from input no one would ever write teaches nothing and puts an
obscure bug on a billboard. The test: would a first-time reader of this object want
this example? If no, it is a unittest. See the `writing-docs` skill.
- **Fix a bug test-first.** Write the regression test before changing the code, run it,
and see it fail for the reason the bug describes, not on an import error or a typo.
Then fix it and see it pass. A test that passed before the fix does not test the fix.
- Never commit `forceSource=True` to a test or doctest (it reparses from source every
run and slows the suite for everyone). The ONLY exception is the one test that exercises
`forceSource` itself. If you hit a stale-parse problem while developing:
Expand Down
Loading