Skip to content

docs: rename requirement IDs to descriptive names and add missing test scenario#89

Merged
jimisola merged 1 commit intomainfrom
docs/rename-req-ids-descriptive
Mar 7, 2026
Merged

docs: rename requirement IDs to descriptive names and add missing test scenario#89
jimisola merged 1 commit intomainfrom
docs/rename-req-ids-descriptive

Conversation

@jimisola
Copy link
Member

@jimisola jimisola commented Mar 7, 2026

Summary

  • Rename all requirement IDs from generic names (REQ_010, REQ_020, REQ_030) to descriptive scenario names (REQ_PASS, REQ_MANUAL_FAIL, REQ_NOT_IMPLEMENTED, REQ_FAILING_TEST, REQ_SKIPPED_TEST)
  • Add new REQ_MISSING_TEST scenario demonstrating an SVC with no corresponding test (shows "M" in reqstool status)
  • Replace placeholder code/tests with real implementations that match each scenario's purpose
  • Add Demo Scenarios table to README documenting all requirement scenarios

Related

Test plan

  • ./mvnw verify -Dmaven.test.failure.ignore=true builds successfully
  • reqstool status local -p ./docs/reqstool shows REQ_MISSING_TEST with M=1 in Automated Tests
  • Verify all 6 scenarios display correctly in reqstool status output

🤖 Generated with Claude Code

…t scenario

Rename all requirement IDs from generic (REQ_010, etc.) to descriptive
names (REQ_PASS, REQ_FAILING_TEST, etc.) that reflect the scenario each
demonstrates. Add REQ_MISSING_TEST scenario showing an SVC with no
corresponding test, and flesh out all demo code with real implementations.

Signed-off-by: jimisola <jimisola@jimisola.com>
@jimisola jimisola self-assigned this Mar 7, 2026
@jimisola jimisola merged commit 9b2c008 into main Mar 7, 2026
6 checks passed
@jimisola jimisola deleted the docs/rename-req-ids-descriptive branch March 7, 2026 22:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant