Commit 9c5de30
docs: OpenSSF Scorecard + Software Heritage badges + CITATION.cff (#85)
## Summary
Three accreditations added with zero new infrastructure required:
1. **OpenSSF Scorecard badge** — numerical score (0–10) alongside the
existing Best Practices boolean badge. Workflow
`.github/workflows/scorecard.yml` already publishes the data; this just
makes it visible.
2. **Software Heritage badge** — automatic archival credential.
softwareheritage.org indexes public GitHub repos without setup; the
badge surfaces it.
3. **CITATION.cff** — Citation File Format 1.2.0. Drives GitHub's "Cite
this repository" sidebar button and is consumable by Zenodo, Zotero,
BibTeX converters, etc.
## What this enables
- The Scorecard score is now externally visible — auditors and
downstream consumers can verify supply-chain posture without inspecting
workflows.
- Software-Heritage archival becomes citable evidence of digital
preservation.
- Academic users can cite BoJ Server properly (OU affiliation surfaced).
## Zenodo (next step, owner action)
README's new **Citing** section documents the 4-step Zenodo enablement
(link via zenodo.org dashboard, flip toggle, cut a release → DOI). After
enablement, add the DOI badge and update `CITATION.cff`'s `doi:` field.
I left the DOI badge OUT of this PR because a placeholder badge is worse
than none.
## What's NOT in this PR
**REUSE compliance** is deferred. `reuse lint` shows the project isn't
compliant — bad licences (EXHIBIT-A/B not `LicenseRef-` prefixed, PMPL
not SPDX-valid), missing `CC-BY-4.0` + `PMPL-2.0-or-later` text files, 4
invalid SPDX expressions. Resolving these collides head-on with the
active licence-debt ledger work (PMPL→MPL-2.0 reconciliation). Better to
land REUSE compliance after that ledger closes so the SPDX fixes happen
exactly once.
## Test plan
- [ ] Scorecard badge renders (will show "loading" briefly, then
numerical score)
- [ ] Software Heritage badge renders
- [ ] GitHub sidebar shows the "Cite this repository" button on the repo
home page
- [ ] No CI regressions (this is docs/config-only)
🤖 Generated with [Claude Code](https://claude.com/claude-code)
---------
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>1 parent b0e52ed commit 9c5de30
3 files changed
Lines changed: 60 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
| 4 | + | |
4 | 5 | | |
5 | 6 | | |
| 7 | + | |
6 | 8 | | |
7 | 9 | | |
8 | 10 | | |
| |||
237 | 239 | | |
238 | 240 | | |
239 | 241 | | |
| 242 | + | |
| 243 | + | |
| 244 | + | |
| 245 | + | |
| 246 | + | |
| 247 | + | |
| 248 | + | |
| 249 | + | |
| 250 | + | |
| 251 | + | |
| 252 | + | |
| 253 | + | |
| 254 | + | |
| 255 | + | |
| 256 | + | |
240 | 257 | | |
241 | 258 | | |
242 | 259 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
44 | 44 | | |
45 | 45 | | |
46 | 46 | | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
47 | 52 | | |
48 | 53 | | |
49 | 54 | | |
| |||
0 commit comments