docs: state the coverage floors rather than the latest figures - #17
Merged
Merged
Conversation
The README gave the coverage of src/core as 93.2% of lines, 82.6% of branches and 99.7% of functions. Those were right for the run they came from and drift with every change to src/core or its tests; the part that stays true is what CI enforces. The paragraph now says that tools/check-coverage.py measures coverage on every pull request, fails the build below 90% of lines or 80% of branches, and prints the current figures in the job summary. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.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.
States what CI enforces about coverage instead of figures from one run.
Why
The README gave the coverage of
src/coreas 93.2% of lines, 82.6% of branches and 99.7% of functions. Those matched the run they came from, and drift with every change tosrc/coreor its tests. What stays true is the floor CI enforces.What changed
The paragraph now says that
tools/check-coverage.pymeasures coverage on every pull request, fails the build below 90% of lines or 80% of branches (MINIMUM_LINE/MINIMUM_BRANCH), and prints the current figures in the job summary (ci.ymltees its output into$GITHUB_STEP_SUMMARY). The sentence about AddressSanitizer and UndefinedBehaviorSanitizer is unchanged.Verification
tools/check-invariants.pypasses locally; documentation only otherwise.🤖 Generated with Claude Code