Fix documentation drift in README and CONTRIBUTING - #41
Merged
Conversation
- Correct git clone URL to the actual org (Stephenson-Software/Parpt) - Correct jar invocation to match the real Spring Boot build output (Parpt-<version>.jar, not parpt.jar) - Correct CONTRIBUTING's license reference (Stephenson-NC, not MIT) to match the actual LICENSE file - Update stale unit test count (58, not 61) Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Member
Author
|
Self-review rubric (this PR is a Stage A documentation accuracy sweep — no source code touched):
Repo-specific rubric items (shell command tests, round-trip coverage, I/O behind an interface): N/A — no command, domain, or persistence code was touched. Summary: docs-only, tightly scoped (2 files, 5 lines changed each direction), every corrected claim checked against source rather than memory. No judgment-call items to flag for follow-up review. This comment was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener). |
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
A documentation accuracy sweep was performed against the current source of truth (LICENSE, build.gradle/settings.gradle output, git remote), and three drift points were found and corrected:
git cloneURL in README's Installation section pointed atPreponderous/Parpt, an org that does not match the actual remote (Stephenson-Software/Parpt) — a new contributor following the steps literally would clone the wrong (or a nonexistent) repository.java -jarcommands in README's Installation and Getting Started sections referencedparpt.jar/build/libs/parpt.jar, but the Spring Boot build actually producesbuild/libs/Parpt-<version>.jar(verified by running./gradlew bootJarand inspectingbuild/libs/). Both references were updated to the glob formbuild/libs/Parpt-*.jarso the doc does not go stale again on the next version bump.grep -rn "@Test" src/test | wc -l); the figure was updated.No source/behavior changes are included — this PR is docs-only.
This PR description was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).
Test plan
./gradlew testrun locally — all 58 tests pass (baseline confirmed unaffected, since only Markdown files were touched)./gradlew bootJarrun locally to confirm the actual jar filename referenced in the corrected README matches real build output