docs: add CLAUDE.md documenting project structure and tests#65
Merged
Conversation
Documents the plugin's internal structure, what each unit test in RequirementsToolTaskTest validates, and how the test fixtures (src/test/resources and tests/fixtures/test_project) relate to the code, including how to manually validate/regenerate expected output. Closes #57 Signed-off-by: Jimisola Laursen <jimisola@jimisola.com>
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
CLAUDE.mddocumenting project structure, theRequirementsToolTaskunit tests and what each one validates, and how the test fixtures (src/test/resources/{yml,zip}andtests/fixtures/test_project) relate to the codesrc/test/resources/{yml,zip}are reference examples not currently loaded by the unit tests, and documents how to usetests/fixtures/test_projectfor manual end-to-end validation / regenerating expected outputTest plan
./gradlew testpassesCloses #57