Skip to content

📖 docs: clarify partial credit logic for Branch-Protection tiers#5010

Open
aban-alazzeh wants to merge 1 commit intoossf:mainfrom
aban-alazzeh:clarify-bp-scoring-docs
Open

📖 docs: clarify partial credit logic for Branch-Protection tiers#5010
aban-alazzeh wants to merge 1 commit intoossf:mainfrom
aban-alazzeh:clarify-bp-scoring-docs

Conversation

@aban-alazzeh
Copy link
Copy Markdown

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.

  • Tests for the changes have been added (for bug fixes/features)

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?

NONE

Signed-off-by: AbdelRahman AlAzzeh <ar.alazzeh003@outlook.com>
@dosubot dosubot bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Apr 8, 2026
@aban-alazzeh aban-alazzeh changed the title docs: clarify partial credit for branch protection tiers 📖 docs: clarify partial credit logic for Branch-Protection tiers Apr 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:XS This PR changes 0-9 lines, ignoring generated files.

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

docs: clarify partial scoring logic in Branch-Protection tiered requirements

1 participant