📖 docs: clarify partial credit logic for Branch-Protection tiers#5010
Open
aban-alazzeh wants to merge 1 commit intoossf:mainfrom
Open
📖 docs: clarify partial credit logic for Branch-Protection tiers#5010aban-alazzeh wants to merge 1 commit intoossf:mainfrom
aban-alazzeh wants to merge 1 commit intoossf:mainfrom
Conversation
Signed-off-by: AbdelRahman AlAzzeh <ar.alazzeh003@outlook.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.
What kind of change does this PR introduce?
Docs update 📖
What is the current behavior?
The documentation for the Branch-Protection check states that "Each tier must be fully satisfied to achieve points at the next tier." This implies an all or nothing scoring model for each tier, leading users to believe they will receive zero points for a tier if even one requirement is missed
What is the new behavior (if this is a feature change)?**
This PR updates the documentation to accurately reflect the implementation logic in checks/evaluation/branch_protection.go. The updated wording clarifies that while tier progression is strict (you cannot earn points for Tier N+1 until Tier N is complete), users do receive partial credit for each requirement met within their current active tier via the normalizeScore function.
Which issue(s) this PR fixes
Fixes #5009
Special notes for your reviewer
I’ve updated docs/checks/internal/checks.yaml and ran the generation script to refresh docs/checks.md. This change makes the "partial credit" logic in normalizeScore more transparent, so users can clearly see how it works.
Does this PR introduce a user-facing change?