chore(bestpractices): rewrite to canonical autofill schema (RAN-57)#96
Merged
Merged
Conversation
Strip the custom group structure (`status` / `evidence` / `audit`) and
rewrite `.bestpractices.json` against bestpractices.dev's flat
per-criterion key/value schema so the autofill robot can pre-fill
the criteria page on board flip.
All 67 passing-level criteria are now answered with `<key>_status`,
`<key>_justification`, and (where required by upstream
`criteria.yml`) `<key>_url`:
- 43 MUST: 42 Met + 1 N/A (`crypto_password_storage` — na_allowed,
codeiq is a developer CLI with no auth surface).
- 10 SHOULD: 9 Met + 1 N/A (`crypto_pfs` — codeiq runs on
localhost; PFS is the operator's responsibility).
- 14 SUGGESTED: 11 Met + 1 N/A (`dynamic_analysis_unsafe` — Java is
memory-safe) + 2 "?" placeholders (`dynamic_analysis`,
`dynamic_analysis_enable_assertions` — no DAST/fuzzing today).
Each justification cites the concrete source-of-truth (`LICENSE`,
`SECURITY.md`, `shared/runbooks/engineering-standards.md` §1–9,
`shared/runbooks/release.md`, `shared/runbooks/test-strategy.md`,
`pom.xml` JaCoCo gate, `.github/workflows/{ci-java,security,scorecard,
release-java,beta-java}.yml`, `.github/dependabot.yml`,
`scripts/setup-git-signed.sh`, `cache/FileHasher.java` SHA-256). The
required `_url` fields on `contribution`, `license_location`,
`release_notes`, `report_process`, `report_archive`,
`vulnerability_report_process`, `vulnerability_report_private`, and
`contribution_requirements` resolve to public GitHub URLs.
Refs: RAN-50 (parent) | RAN-52 (codeiq OpenSSF lane) | bestpractices.dev/projects/12650
Co-Authored-By: Paperclip <noreply@paperclip.ing>
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.
Summary
Closes RAN-57. Rewrites
.bestpractices.jsonfrom the custom group structure (status/evidence/auditkeys) to bestpractices.dev's canonical flat per-criterion schema so the autofill robot can pre-fill the criteria page on board flip for project_id 12650.All 67
passing-level criteria from upstreamcriteria.yml(top-level'0':block) are now answered with<key>_status+<key>_justification+ (wheremet_url_required: trueupstream)<key>_url:Met, 1N/A(crypto_password_storage—na_allowed: true; codeiq is a developer CLI with no auth surface)Met, 1N/A(crypto_pfs—servebinds to localhost; PFS is the operator's concern perSECURITY.mdscope)Met, 1N/A(dynamic_analysis_unsafe— Java is memory-safe), 2?placeholders (dynamic_analysis,dynamic_analysis_enable_assertions— no DAST/fuzzing pipeline today)Each justification cites the concrete source-of-truth:
LICENSE,SECURITY.md,shared/runbooks/engineering-standards.md§1–9,shared/runbooks/release.md,shared/runbooks/test-strategy.md,pom.xmlJaCoCo coverage gate,.github/workflows/{ci-java,security,scorecard,release-java,beta-java}.yml,.github/dependabot.yml,scripts/setup-git-signed.sh,cache/FileHasher.java(SHA-256), GitHub Releases, GHSA advisory channel.The 8
met_url_required: truecriteria (contribution,license_location,release_notes,report_process,report_archive,vulnerability_report_process,vulnerability_report_private,contribution_requirements) resolve to public GitHub URLs.Schema validated locally: 67/67 criteria covered, all
_statusvalues in {Met,Unmet,N/A,?}, everymet_url_requiredcriterion withMetstatus carries a_url.Refs
coreinfrastructure/best-practices-badgecriteria/criteria.ymltop-level'0':Test plan
JSON.parse(.bestpractices.json)succeeds_status+_justificationmet_url_requiredcriteria carry a valid_url_statusvaluesmvn -B -ntp clean verify+ OSS-CLI security stack + Scorecard) — auto-merge on greenpassing(manual board action — out of repo scope)🤖 Generated with Claude Code