chore: add .bestpractices.json for OpenSSF badge automation#45
Merged
Conversation
The BestPractices badge site (bestpractices.dev) auto-discovers
.bestpractices.json at the repo root and pre-fills criterion
status/justification pairs from it.
Pre-fills 86 entries for project 12628:
- 68 Met (with evidence URLs / file paths)
- 10 N/A (with reasons — no user passwords, no custom crypto, etc.)
- 8 ? TODO (code_of_conduct, governance, roles_responsibilities,
access_continuity, bus_factor, report_archive,
release_notes_vulns, accessibility_best_practices)
Ref: https://github.com/coreinfrastructure/best-practices-badge/blob/main/docs/automation-proposals.md
Badge URL: https://www.bestpractices.dev/en/projects/12628
Automation URL: https://raw.githubusercontent.com/RandomCodeSpace/docsiq/main/.bestpractices.json
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.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
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.
Summary
Adds
.bestpractices.jsonat repo root so the BestPractices badge site (project 12628) can auto-fill criterion justifications on its next re-scan.Pre-fills 86 entries:
?— flagged as TODO for follow-up (code_of_conduct, governance, roles_responsibilities, access_continuity, bus_factor, report_archive, release_notes_vulns, accessibility_best_practices)Why
Manual form entry of 86 justifications is error-prone and drifts from repo state. The
.bestpractices.jsonfile is the documented automation path per automation-proposals.md. Badge site auto-discovers it and re-applies on every re-scan.Automation URL
(Implicit — no manual entry needed. Badge site fetches on re-analysis.)
Follow-up
After merge, to flip the 8
?→ Met, a separate PR should add:CODE_OF_CONDUCT.md(Contributor Covenant 2.1)GOVERNANCE.md(BDFL + security contact continuity).github/CODEOWNERS.github/release.yml(security-label section template)docs/ACCESSIBILITY.md(WCAG AA stance for SPA)That should carry the badge from 22% → 100% passing tier.
Test plan
python3 -c 'json.load(open(...))')?/ 86 total🤖 Generated with Claude Code