Give every test a rationale block - #23
Merged
Merged
Conversation
133 of the 271 Kotlin tests and the three Java fuzz targets had no three-question rationale block, so the generated test-evidence page listed them without a "what / how / why". Every test now opens with the block, written against the test body and the production class under test; no test code changed. The catalog script additionally scans src/test/java and matches the Surefire name of a parameterized Java method (`name(Type)[n]`) to its source, so the fuzz targets are documented on the page as well: the local run now reports 269 of 269 tests with a rationale block. CONTRIBUTING states the rule explicitly. mvn -o verify (ktlint, full offline suite) passes. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015GfdGp7eUrjJKBvcJUx3q2
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.
Summary
What is to be tested?/How will the test case be deemed successful and why?/Why is it important to test this test case?, written against the test body and the production class under test. No test code changed (insert-only diff).generate-test-catalog.pyadditionally scanssrc/test/javaand strips the Surefire(Type)[n]suffix of parameterized Java methods, so the Jazzer fuzz targets appear with their rationale too. Local run: 269 of 269 tests with a rationale block.Test plan
mvn -o verify(ktlint, full offline suite)*Test.ktgenerate-test-catalog.pyon the local Surefire output: 269/269 documented🤖 Generated with Claude Code
https://claude.ai/code/session_015GfdGp7eUrjJKBvcJUx3q2