docs(prose): tighten README caveats and CHANGELOG SemVer claim#17
Open
brittanyreese wants to merge 1 commit into
Open
docs(prose): tighten README caveats and CHANGELOG SemVer claim#17brittanyreese wants to merge 1 commit into
brittanyreese wants to merge 1 commit into
Conversation
- README: merge two consecutive DIF Note blockquotes that both closed on the same fairness-verdict disclaimer into one note stating both mechanisms (nested-strata confound, panel-wide shared bias) with a single close. - README: trim the demo-contrast paragraph, dropping the 'the contrast is the point' opener and the unanimous/unanimously wordplay. - CHANGELOG: state SemVer adherence directly instead of 'aims to follow'.
There was a problem hiding this comment.
Pull request overview
This PR performs a small public-surface prose tightening to reduce ambiguity in user-facing docs, primarily around DIF caveats and a SemVer adherence statement.
Changes:
- Consolidates two adjacent DIF caveat blockquotes in the README into a single, clearer note covering both limitations and the external-conditioner recommendation.
- Rewords the README reliability contrast paragraph to remove rhetorical phrasing while preserving the underlying caution.
- Updates the CHANGELOG header language from “aims to follow” to a direct adherence claim for Keep a Changelog and SemVer.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Merges/streamlines DIF caveats and tightens reliability contrast wording. |
| CHANGELOG.md | Strengthens the header statement to assert Keep a Changelog + SemVer adherence. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Prose scrub from a public-surface audit (README, CHANGELOG, SPEC, AGENTS, roadmap). Three genuine findings, all here; the rest of the surface was already clean (zero em dashes, no promotional language).
> Note:blockquotes both closed on the same 'not a fairness verdict' disclaimer. Merged into one note covering both mechanisms (nested-strata confound + panel-wide shared bias) with a single close.Pre-existing prose, kept separate from #15 (bias-conditioner examples).