feat(reqstool): add build config conventions for JUnit5 parameterized test names#29
Merged
Merged
Conversation
… test names Document the Gradle/JUnit5 systemProperty fix for parameterized test display names so reqstool can map JUnit XML test results back to @SVCs-annotated methods, avoiding "Skipping parameterized test case" warnings. Adds reqstool-build-config-conventions.md (scoped to Gradle/JUnit5, with notes on the explicit @ParameterizedTest(name=...) override and Maven Surefire being unaffected), and links it from SKILL.md, reqstool-conventions.md, skills.adoc, and README.md. Closes #28 Signed-off-by: Jimisola Laursen <jimisola@jimisola.com>
1716804 to
e47040c
Compare
jimisola
commented
Jun 13, 2026
jimisola
left a comment
Member
Author
There was a problem hiding this comment.
Full PR Review — Consolidated Findings (fixed)
Ran 7 parallel checks (review, code-review, smells, advanced-smells, security, cruft, testing) against the original diff. Security and cruft checks passed clean. All actionable findings below have been addressed in this push:
| # | Prio | Finding | Resolution |
|---|---|---|---|
| 1 | Medium | Doc's own example looked like a custom @ParameterizedTest(name=...) case, which the systemProperty default doesn't fix |
Added an explicit caveat block + rewrote examples to match upstream PR #63's [1] ACTIVE → checkStatus(StatusType)[1] |
| 2 | Medium | README.md has a third, pre-existing listing of reqstool-conventions reference docs that wasn't updated |
Added a bullet for the new doc |
| 3 | Medium | New doc is Gradle/Java-specific but unscoped in a multi-language skill | Added a scope note (Gradle + JUnit 5 only; Maven Surefire unaffected) |
| 4 | Medium | No CI check that reference docs are listed everywhere they should be (this PR illustrates the gap) | Filed follow-up issue #30 (non-blocking) |
| 5 | Low | "During reqstool validate" — verified against reqstool-client source: validate is a real subcommand, but the warning fires during any test-result processing (e.g. reqstool status) |
Reworded to "When reqstool processes the JUnit XML test results (e.g. via reqstool status)" |
| 6 | Low | reqstool-java-gradle-plugin#63 is an open/unmerged PR cited as settled guidance; reqstool-client#405 linked/labeled as an issue |
Confirmed via gh pr view: #63 is OPEN, #405 is a MERGED PR. Updated links/labels accordingly, noted #63 is open |
| 7 | Low | Example warning text didn't match the actual reqstool-client log format; inconsistent example values across sections |
Replaced with the real log message format and a single consistent example ([1] ACTIVE / checkStatus(StatusType)[1], matching upstream PR #63) |
| 8 | Low | Redundant sentence repeating what the code blocks already show | Removed |
| 9 | Low | ### References (H3, nested) vs sibling docs' top-level ## References |
Promoted to ## References |
| 10 | Info | Commit/PR were typed docs(reqstool): but this adds new skill guidance/behavior (a feat), consistent with the minor version bumps already applied |
Amended commit + retitled PR to feat(reqstool): ... |
Automated — /x:full-pr-review
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.
Summary
reqstool-build-config-conventions.mdreference doc to thereqstool-conventionsskill, documenting the Gradle/JUnit5systemPropertyfix for parameterized test display names (Kotlin & Groovy DSL), scoped to Gradle/JUnit5 with notes on the explicit@ParameterizedTest(name=...)override and Maven Surefire being unaffectedSKILL.md,reqstool-conventions.md,docs/modules/ROOT/pages/skills.adoc, andREADME.mdplugins/reqstoolplugin version 0.3.0 → 0.4.0 and marketplace version 0.4.1 → 0.5.0 per CLAUDE.md versioning rules — this adds new guidance/behavior to the auto-appliedreqstool-conventionsskill, so it's afeat, not a docs/typo fixThis addresses #28: without this configuration, reqstool emits "Skipping parameterized test case with display-name-only format (method name not recoverable)" warnings for Gradle/JUnit5 projects and the corresponding
@SVCsIDs never get marked as verified.Closes #28
Test plan
reqstool-conventionsreference docsplugin.json/marketplace.jsonremain valid JSON with bumped versionsSKILL.md,reqstool-conventions.md,skills.adoc, andREADME.mdpoint to the new filereqstool-clientsource, and the@ParameterizedTest(name=...)caveat againstreqstool-java-gradle-pluginPR #63