docs: document health score calculation and weights (#717)#741
Merged
Baskarayelu merged 1 commit intoJun 18, 2026
Merged
Conversation
Contributor
Author
|
Heads-up: the failing checks come from pre-existing compile errors in reporting/src/tests.rs that already exist on the base branch (93ad812) — not from this PR, which only adds documentation (markdown + /// doc comments, no compiled code). cargo doc -p reporting --no-deps builds clean. Happy to rebase on a newer main if these have since been fixed upstream. |
Contributor
|
nice, the HEALTH_SCORE.md walkthrough of the savings/bills/insurance weighting finally makes that score auditable from the outside. merging 📚 |
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
2 participants
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.
Description
Documents the
calculate_health_scorelogic and component weights to make the algorithm fully auditable for reviewers and integrators.Changes
docs/HEALTH_SCORE.md: Details component weights (Savings 0-40, Bills 0-40, Insurance 0-20), clamping behavior, and missing report handling, plus worked examples.calculate_health_scoreandHealthScore.