Skip to content

Commit dc83b02

Browse files
hyperpolymathclaude
andcommitted
chore(wp4): de-brand root Justfile + convert READINESS to AsciiDoc
De-template the root Justfile (no functional recipe changes to the live snifs recipes): - project/REPO := "rsr-template-repo" -> "snifs" (16 {{project}} sites) - scope the verify-template self-check to the project/REPO assignment so it no longer trips on its own grep pattern - de-brand doctor/tour/help-me/container-init prose + the issues URL - drop the "RSR Standard Justfile Template / copy me" header framing Convert READINESS.md -> READINESS.adoc (DOC-FORMAT: .adoc is primary; READINESS is not on the allowed-.md list): fill {{DATE}} -> 2026-06-17, snif -> snifs. Retarget crg-grade/crg-badge to read READINESS.adoc and its '*Current Grade:*' line. Also fix a pre-existing bug in crg-grade/crg-badge (present on main): '$$(' / '$$grade' produced a bash syntax error in these plain recipes; command substitution needs a single '$' (as state-touch already uses). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent e9cba18 commit dc83b02

3 files changed

Lines changed: 72 additions & 80 deletions

File tree

Justfile

Lines changed: 22 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,7 @@
22
# Owner: Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
33
# Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath) <j.d.a.jewell@open.ac.uk>
44
#
5-
# RSR Standard Justfile Template
6-
# https://just.systems/man/en/
7-
#
8-
# Copy this file to new projects and customize the placeholder values.
5+
# snifs — task runner (https://just.systems/man/en/)
96
#
107
# Run `just` to see all available recipes
118
# Run `just cookbook` to generate docs/just-cookbook.adoc
@@ -19,10 +16,10 @@ set positional-arguments := true
1916
# Re-generate with: contractile gen-just
2017
import? "contractile.just"
2118

22-
# Project metadata — customize these
23-
project := "rsr-template-repo"
19+
# Project metadata
20+
project := "snifs"
2421
OWNER := "hyperpolymath"
25-
REPO := "rsr-template-repo"
22+
REPO := "snifs"
2623
version := "0.1.0"
2724
tier := "infrastructure" # 1 | 2 | infrastructure
2825

@@ -333,9 +330,10 @@ verify-template:
333330
FOUND=1
334331
fi
335332
336-
# Check for template defaults still present
337-
if grep -q 'rsr-template-repo' Justfile 2>/dev/null; then
338-
echo "⚠ Justfile still references 'rsr-template-repo' — update project name"
333+
# Check the project/REPO assignments have been de-branded from the template default.
334+
# Scoped to the variable assignment so the check never trips on its own grep pattern.
335+
if grep -qE '^(project|REPO)[[:space:]]*:=[[:space:]]*"rsr-template-repo"' Justfile 2>/dev/null; then
336+
echo "⚠ Justfile project/REPO still set to 'rsr-template-repo' — update project name"
339337
FOUND=1
340338
fi
341339
@@ -690,18 +688,18 @@ readiness:
690688
# cargo test --test readiness -- --nocapture
691689
@echo "Readiness tests complete!"
692690

693-
# Print the current CRG grade (reads from READINESS.md '**Current Grade:** X' line)
691+
# Print the current CRG grade (reads from READINESS.adoc '*Current Grade:* X' line)
694692
crg-grade:
695-
@grade=$$(grep -oP '(?<=\*\*Current Grade:\*\* )[A-FX]' READINESS.md 2>/dev/null | head -1); \
696-
[ -z "$$grade" ] && grade="X"; \
697-
echo "$$grade"
693+
@grade=$(grep -oP '(?<=\*Current Grade:\* )[A-FX]' READINESS.adoc 2>/dev/null | head -1); \
694+
[ -z "$grade" ] && grade="X"; \
695+
echo "$grade"
698696

699697
# Print a shields.io CRG badge for embedding in README files
700-
# Looks for '**Current Grade:** X' in READINESS.md; falls back to X
698+
# Looks for '*Current Grade:* X' in READINESS.adoc; falls back to X
701699
crg-badge:
702-
@grade=$$(grep -oP '(?<=\*\*Current Grade:\*\* )[A-FX]' READINESS.md 2>/dev/null | head -1); \
703-
[ -z "$$grade" ] && grade="X"; \
704-
case "$$grade" in \
700+
@grade=$(grep -oP '(?<=\*Current Grade:\* )[A-FX]' READINESS.adoc 2>/dev/null | head -1); \
701+
[ -z "$grade" ] && grade="X"; \
702+
case "$grade" in \
705703
A) color="brightgreen" ;; \
706704
B) color="green" ;; \
707705
C) color="yellow" ;; \
@@ -710,7 +708,7 @@ crg-badge:
710708
F) color="critical" ;; \
711709
*) color="lightgrey" ;; \
712710
esac; \
713-
echo "[![CRG $$grade](https://img.shields.io/badge/CRG-$$grade-$$color?style=flat-square)](https://github.com/hyperpolymath/standards/tree/main/component-readiness-grades)"
711+
echo "[![CRG $grade](https://img.shields.io/badge/CRG-$grade-$color?style=flat-square)](https://github.com/hyperpolymath/standards/tree/main/component-readiness-grades)"
714712

715713
# Run the full merge-requirement test suite (ALL categories)
716714
# Per STANDING rule: P2P + E2E + aspect + execution + lifecycle + bench
@@ -867,7 +865,7 @@ container-init:
867865
868866
if [ ! -d "container" ]; then
869867
echo "Error: container/ directory not found."
870-
echo "This repo may not have been created from rsr-template-repo."
868+
echo "Expected a container/ directory with Containerfile + compose templates."
871869
exit 1
872870
fi
873871
@@ -1303,7 +1301,7 @@ assail:
13031301
13041302
# Self-diagnostic — checks dependencies, permissions, paths
13051303
doctor:
1306-
@echo "Running diagnostics for rsr-template-repo..."
1304+
@echo "Running diagnostics for snifs..."
13071305
@echo "Checking required tools..."
13081306
@command -v just >/dev/null 2>&1 && echo " [OK] just" || echo " [FAIL] just not found"
13091307
@command -v git >/dev/null 2>&1 && echo " [OK] git" || echo " [FAIL] git not found"
@@ -1313,7 +1311,7 @@ doctor:
13131311
13141312
# Guided tour of key features
13151313
tour:
1316-
@echo "=== rsr-template-repo Tour ==="
1314+
@echo "=== snifs Tour ==="
13171315
@echo ""
13181316
@echo "1. Project structure:"
13191317
@ls -la
@@ -1328,12 +1326,12 @@ tour:
13281326
13291327
# Open feedback channel with diagnostic context
13301328
help-me:
1331-
@echo "=== rsr-template-repo Help ==="
1329+
@echo "=== snifs Help ==="
13321330
@echo "Platform: $(uname -s) $(uname -m)"
13331331
@echo "Shell: $SHELL"
13341332
@echo ""
13351333
@echo "To report an issue:"
1336-
@echo " https://github.com/hyperpolymath/rsr-template-repo/issues/new"
1334+
@echo " https://github.com/hyperpolymath/snifs/issues/new"
13371335
@echo ""
13381336
@echo "Include the output of 'just doctor' in your report."
13391337

READINESS.adoc

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
// SPDX-License-Identifier: MPL-2.0
2+
// Owner: Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
3+
// Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath) <j.d.a.jewell@open.ac.uk>
4+
= snifs Component Readiness Assessment
5+
:toc: preamble
6+
7+
*Standard:* https://github.com/hyperpolymath/standards/tree/main/component-readiness-grades[Component Readiness Grades (CRG) v2.2] +
8+
*Current Grade:* C +
9+
*Assessed:* 2026-06-17 +
10+
*Assessor:* Jonathan D.A. Jewell
11+
12+
== Summary
13+
14+
[cols="2,1,2,4", options="header"]
15+
|===
16+
| Component | Grade | Release Stage | Evidence Summary
17+
18+
| Primary component | C | Alpha-stable | Dogfooded on own project; CI passing
19+
|===
20+
21+
*Overall:* Grade C — dogfooding confirmed, CI passing, deep annotation in place.
22+
23+
== Grade C Evidence
24+
25+
* Deployed and dogfooded on the snifs project itself
26+
* CI passing (dogfood-gate, hypatia-scan, static-analysis-gate)
27+
* `TEST-NEEDS.md` documents the test matrix
28+
* No home failures
29+
* Deep code and folder annotation in place per CRG v2 requirements
30+
31+
== Promotion Path to Grade B
32+
33+
Grade B requires: *6+ diverse external targets tested, issues fed back*.
34+
35+
Diversity means: different languages, different architectures, different use cases.
36+
37+
To reach B:
38+
39+
. Deploy on at least 6 external projects that differ meaningfully from each other
40+
. Confirm it works in each (or document failures)
41+
. Feed back any issues found (GitHub issues or PRs)
42+
. Update this file with the evidence
43+
44+
== Concerns and Maintenance Notes
45+
46+
_Document any known limitations, demotion risks, or maintenance concerns here._
47+
48+
'''
49+
50+
Run `just crg-badge` to generate the shields.io badge for your README.

READINESS.md

Lines changed: 0 additions & 56 deletions
This file was deleted.

0 commit comments

Comments
 (0)