Repository navigation
Record lessons from review in AGENTS.md - #212
Merged
Merged
Conversation
Rules that review has already had to enforce once, here or in the emitter this library is tested against: prove a test by breaking what it guards, treat docstrings, the README and the changelog as shipped, keep the public surface complete and free of dormant parameters, read captured data as published, check against every capture, cite the specification, and report only results that were run.
What a change must do is settled in its specification; AGENTS.md keeps the checks made while writing and verifying it: break what a test guards, read the docs a docs test protects, check the changelog as it ships, read data as published, check every capture, and measure claims.
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
1 participant
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.
Adds a "Lessons from review" section to
AGENTS.md: rules that review has already had to enforce once, here or in the emitter this library is tested against.Documentation only.
pre-commit runon the file and the commit hook's full suite pass: 1856 passed, 7 skipped, 9 xfailed.