Skip to content

Docs: Add testing guidance to AGENTS.md #18166

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
pvary merged 1 commit into from
Sep 21, 2026
+7 −0
Merged

Docs: Add testing guidance to AGENTS.md #18166

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
7 changes: 7 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,13 @@ The `api/` module has the strongest stability guarantees — breaking changes ar

### Testing

**Write the test plan before the tests.** State in the PR description what behavior needs verifying and why each case matters — a few lines, not a document.

- Test the behavior in the plan. Coverage is not a target.
- Test the behavior this change adds or modifies. Don't assert the correctness of components this code merely calls.
- One behavior per test method. No omnibus tests asserting several unrelated things.
- Don't add a test whose failure would not indicate a user-visible regression.
- Don't add tests for unreachable states, or tests that only restate the implementation.
Comment on lines +142 to +146

@anuragmantri anuragmantri Sep 18, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good set of instructions. I would add this.

  • Do not add excessive comments in tests when the intention is clear from the test method name.

@pvary pvary Sep 21, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this covered by #18167 in a more general way?

- Don't write a comment that restates the method name, the condition, or the next line.

@anuragmantri anuragmantri Sep 21, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then general one works. Thanks.

- Minimal test setup: `PartitionSpec.unpartitioned()` when partitioning isn't needed.
- Test classes and methods should be package private unless required by inheritance.
- Compute expected values, don't hardcode. Tests belong in the module that owns the code.
Expand Down
Loading