Skip to content

Commit 1c1920e

Browse files
hyperpolymathclaude
andcommitted
docs(crg): add machine-readable grade declaration and badge convention (v2.2)
Defines **Current Grade:** line in READINESS.md as the machine-readable grade anchor. Documents just crg-grade / just crg-badge tooling. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 4ee0e75 commit 1c1920e

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

component-readiness-grades/COMPONENT-READINESS-GRADES.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -642,10 +642,39 @@ requirement is missing.
642642

643643
---
644644

645+
## Machine-Readable Grade Declaration
646+
647+
Projects using CRG SHOULD include a `READINESS.md` in their repository root with
648+
the following line to enable automated badge generation and grade querying:
649+
650+
```markdown
651+
**Current Grade:** B
652+
```
653+
654+
Replace `B` with the current overall project grade (the worst grade of any
655+
deployed component, or the grade of the primary component if the project is
656+
single-component). This line is parsed by `just crg-grade` and `just crg-badge`
657+
from the `rsr-template-repo` Justfile.
658+
659+
### Badge Generation
660+
661+
Run `just crg-badge` in any repo that has a `READINESS.md` with the above line.
662+
This outputs a shields.io badge in Markdown format:
663+
664+
```markdown
665+
[![CRG B](https://img.shields.io/badge/CRG-B-green?style=flat-square)](https://github.com/hyperpolymath/standards/tree/main/component-readiness-grades)
666+
```
667+
668+
Embed this badge in `README.adoc` using Asciidoc image syntax or in `README.md`
669+
directly.
670+
671+
---
672+
645673
## Revision History
646674

647675
| Version | Date | Author | Changes |
648676
|---------|------------|-------------------------|------------------|
677+
| 2.2 | 2026-04-04 | Jonathan D.A. Jewell | Added machine-readable grade declaration standard and badge generation convention |
649678
| 2.1 | 2026-04-03 | Jonathan D.A. Jewell | Added Immaculate Guide compliance as Grade D gate requirement for hyperpolymath projects |
650679
| 2.0 | 2026-03-30 | Jonathan D.A. Jewell | Raised bar for alpha/beta/publication, added RSR and deep-annotation requirements, added v2 sign-off and challenge posture |
651680
| 1.0 | 2026-02-28 | Jonathan D.A. Jewell | Initial release |

0 commit comments

Comments
 (0)