docs: document quality-aware scoring in CHANGELOG and README - #22
Merged
Conversation
Follow-up to the quality-aware scoring change (#21), which shipped without user-facing docs. - CHANGELOG: add an [Unreleased] Changed entry covering the quality factor, the net-cash reward, the Debt -> Balance Sheet rename, the reweighting, and the preserved rank order. - README: update the rating-buckets table to the shipped weights (15/17/10/11/10/12/10/5/5/5, +5 ESG) with the Balance Sheet bucket, and add a short note explaining quality-aware valuation and the net-cash effect.
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.
Why
Follow-up to #21 (quality-aware scoring), which shipped without updating the user-facing docs. The README still advertised the old rating model (a Debt bucket and weights
15/15/10/10/15/10/…) and the CHANGELOG had no entry.What changed
CHANGELOG.md — new
[Unreleased] → Changedentry describing the quality factor, the net-cash reward, the Debt → Balance Sheet rename, the reweighting, and the preserved rank order (Spearman ≈ 0.99).README.md — rating-buckets table updated to the shipped weights and the Balance Sheet bucket:
plus a short note explaining that valuation is now quality-aware and that net cash strengthens (and net debt weakens) the score.
Docs-only — no code or tests affected. Weights verified against
scoring.WEIGHTS.