[Docs] Add software health index badge - #1153
Open
Nayjest wants to merge 3 commits into
Open
Conversation
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.
This PR adds the inspect.software health badge to the README.
Why this PR?
Your project ranks in the upper rating bands of our open-source health index (which measures maintainability, responsiveness, and security). This badge makes that standing objectively visible to your users. Our index is a free public good, and scores cannot be bought.
Technical details:
If you prefer to keep your README minimal, feel free to close this PR without replying. Your report will remain publicly available and up-to-date either way.
Summary
Adds one line to the README badge row. No code changes.
Test plan
README-only; no dependent tests. Rendering verified on the branch.
Benchmark / NCU (kernel changes only)
Neutral — no kernel changes.
Breaking changes
None.
Checklist
If you cannot tick the "not minor" box above
The "no busywork" rule is aimed at typos and style churn, and it's a good rule. This isn't that: it adds a link to an independent health report for this repository — public methodology, versioned, recomputed on every scan — so readers can check the project's standing rather than infer it. One line, trivially reversible.