Repository navigation
docs: make coverage README contributor-focused and quality-first - #16
Merged
Merged
Conversation
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.com>
Signed-off-by: Vitor Mattos <1079143+vitormattos@users.noreply.github.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
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.
Why
The previous README led with GitHub Actions implementation details, data retention, hosting, and licensing. That made it difficult for a new contributor or an organization using LibreSign to understand the purpose of the coverage project.
Coverage is a diagnostic signal—not a quality target in isolation. The landing page of this repository should guide developers toward meaningful tests and improvements to the LibreSign PHP application.
Changes
docs/understanding-coverage.mdand publisher architecture, permissions, retention, and maintenance intodocs/maintainers.md.LICENSEfile, without a README license footer.The main README is now 72 lines (from over 200). This PR modifies documentation and one documentation assertion; no runtime, CI workflow, coverage data, or PHP application behavior is changed.
Verification
python3 -m unittest discover -s tests -q: 52 tests passed.actionlinton the repository's three workflows passed.git diff --checkpassed.Accuracy notes
The LibreSign source publishing integration is still tracked in LibreSign/libresign#9387, not yet merged; the new docs explicitly distinguish a
Previewsnapshot from verifiedmaincoverage.Review
Please review the README's reader journey and quality principles first, then the two linked reference documents. No automatic merge requested.