Skip to content

Commit 2c3b718

Browse files
hyperpolymathclaude
hyperpolymath
and
claude
authored
chore: close-out hygiene — SPDX fix, fill template placeholders, refresh 6a2 state (#37)
- SPDX: PMPL-1.0-or-later -> MPL-2.0 in governance.yml, hypatia-scan.yml, scorecard.yml (matches repo policy + the no-pmpl contractile rule). - Fill unfilled {{...}} template placeholders with real values: anchors/ANCHOR.a2ml, flake.nix (+enable Rust/Idris2/Zig dev shell), guix.scm, .guix-channel. - Refresh .machine_readable/6a2: STATE (date, PRs #34/#35/#36, blockers), PLAYBOOK (document branch-cleanup workflow + proxy-blocks-deletes), NEUROSYM (record upstream standards@5a93d9d Hypatia pin breakage). - QUICKSTART-DEV.adoc: fill placeholders and correct non-existent recipe names (setup-dev/panic-scan/llm-context -> real recipes). Claude-Session: https://claude.ai/code/session_01Y2MWTAqX2x7goVJzjFB4j5 Co-authored-by: Claude <noreply@anthropic.com>
1 parent 607c133 commit 2c3b718

11 files changed

Lines changed: 136 additions & 89 deletions

File tree

‎.github/workflows/governance.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# SPDX-License-Identifier: PMPL-1.0-or-later
1+
# SPDX-License-Identifier: MPL-2.0
22
name: Governance
33

44
on:

‎.github/workflows/hypatia-scan.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# SPDX-License-Identifier: PMPL-1.0-or-later
1+
# SPDX-License-Identifier: MPL-2.0
22
name: Hypatia Security Scan
33

44
on:

‎.github/workflows/scorecard.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# SPDX-License-Identifier: PMPL-1.0-or-later
1+
# SPDX-License-Identifier: MPL-2.0
22
name: OSSF Scorecard
33

44
on:

‎.guix-channel‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
;; SPDX-License-Identifier: MPL-2.0
2-
;; Copyright (c) {{CURRENT_YEAR}} {{AUTHOR}} ({{OWNER}}) <{{AUTHOR_EMAIL}}>
2+
;; Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath) <j.d.a.jewell@open.ac.uk>
33
;;
4-
;; Guix channel definition for {{PROJECT_NAME}}
4+
;; Guix channel definition for wokelangiser
55
;;
66
;; To use this channel, add to ~/.config/guix/channels.scm:
77
;;
88
;; (channel
9-
;; (name '{{PROJECT_NAME}})
10-
;; (url "https://github.com/{{OWNER}}/{{PROJECT_NAME}}")
9+
;; (name 'wokelangiser)
10+
;; (url "https://github.com/hyperpolymath/wokelangiser")
1111
;; (branch "main"))
1212
;;
1313
;; Then: guix pull
1414

1515
(channel
1616
(version 0)
17-
(url "https://github.com/{{OWNER}}/{{PROJECT_NAME}}")
17+
(url "https://github.com/hyperpolymath/wokelangiser")
1818
(dependencies
1919
(channel
2020
(name 'guix)

‎.machine_readable/6a2/NEUROSYM.a2ml‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
[metadata]
88
version = "0.1.0"
9-
last-updated = "2026-03-21"
9+
last-updated = "2026-06-21"
1010

1111
[hypatia-config]
1212
scan-enabled = true
@@ -30,3 +30,14 @@ rules = [
3030
# Neural pattern detection settings
3131
confidence-threshold = 0.85
3232
# model = "hypatia-v2"
33+
34+
[known-issues]
35+
# The standards-reusable Hypatia scan currently fails at action-resolution:
36+
# hypatia-scan.yml pins hyperpolymath/standards@5a93d9d57cc04de4002d6d0ecd336fc7a8698910,
37+
# whose hypatia-scan-reusable.yml references an unresolvable
38+
# actions/cache@d4373f267a887d77f9eb0683a479ec60b1fe5b2b.
39+
# The repo's other Hypatia job ("Hypatia neurosymbolic scan") still passes, so
40+
# analysis coverage is retained. Fix: repair the pin upstream in
41+
# hyperpolymath/standards, then bump the consumer pins.
42+
hypatia-scan-status = "failing-upstream-pin"
43+
affected-workflows = ["hypatia-scan.yml", "governance.yml", "scorecard.yml"]

‎.machine_readable/6a2/PLAYBOOK.a2ml‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
[metadata]
88
version = "0.1.0"
9-
last-updated = "2026-03-21"
9+
last-updated = "2026-06-21"
1010

1111
[deployment]
1212
method = "ci-triggered"
@@ -40,3 +40,16 @@ artifacts = ["wokelangiser (CLI)", "libwokelangiser.so (FFI)"]
4040
# just perms-audit
4141
# ABI-FFI consistency check:
4242
# Compare struct sizes: ConsentRecord=24B, AccessibilityRecord=32B, I18nRecord=24B
43+
44+
[branch-cleanup]
45+
# The development git proxy returns HTTP 403 on `git push --delete`, so stale
46+
# branches cannot be removed from a clone. Delete them server-side instead via
47+
# the reusable workflow, which calls the GitHub REST API with GITHUB_TOKEN on the
48+
# runner (bypassing the proxy):
49+
# Actions -> "Branch Cleanup" -> Run workflow
50+
# branches = "claude/foo claude/bar" (space-separated)
51+
# dry_run = true (preview first; set false to actually delete)
52+
workflow = ".github/workflows/branch-cleanup.yml"
53+
trigger = "workflow_dispatch"
54+
dry-run-default = true
55+
protected = ["main", "cicd/codeql-cron-monthly", "estate-standardization-20260607"]

‎.machine_readable/6a2/STATE.a2ml‎

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
[metadata]
66
project = "wokelangiser"
77
version = "0.1.0"
8-
last-updated = "2026-03-21"
8+
last-updated = "2026-06-21"
99
status = "active"
10-
session = "converted from scheme — 2026-04-11"
10+
session = "RSR/security hardening + branch-cleanup automation — 2026-06-21"
1111

1212
[project-context]
1313
name = "Wokelangiser"
@@ -20,21 +20,34 @@ maturity = "experimental" # experimental | alpha | beta | production | lts
2020

2121
[route-to-mvp]
2222
milestones = [
23-
# No milestones recorded
23+
"Implement src/codegen/* target emission (consent / accessibility / i18n) — currently stubbed",
24+
"First end-to-end example: manifest -> validated -> generated wrapper",
25+
"Begin Idris2 formal proofs for domain-specific invariants",
26+
"Repair upstream hyperpolymath/standards@5a93d9d CI pin (see blockers)",
2427
]
2528

2629
[blockers-and-issues]
2730
issues = [
28-
"Phase 1 complete — no blockers. Phase 2 requires domain logic implementation.",
31+
"CI: Hypatia, OSSF Scorecard and Rust CI fail because hyperpolymath/standards@5a93d9d pins an unresolvable actions/cache@d4373f... SHA; needs an upstream fix plus a consumer pin bump.",
32+
"Codegen (src/codegen/*) is stubbed — the `generate` pipeline is not yet functional end-to-end.",
2933
]
3034

3135
[critical-next-actions]
3236
actions = [
33-
"Implement core domain logic in src/core/",
37+
"Implement core codegen in src/codegen/ (consent.rs, accessibility.rs, i18n.rs)",
3438
"Write first end-to-end example with real input",
35-
"Begin Idris2 formal proofs for domain-specific invariants",
39+
"Bump standards pin once hyperpolymath/standards repairs actions/cache",
40+
]
41+
42+
[recent-changes]
43+
# 2026-06-21 session
44+
changes = [
45+
"#34 merged: CodeQL Rust SAST added; scorecard-enforcer de-published; setup.sh `just` installer hardened (pinned + SHA256).",
46+
"#35 merged: cleared Hypatia secret false-positives (.envrc / .envrc.example / setup.sh).",
47+
"#36 merged: added reusable .github/workflows/branch-cleanup.yml (server-side ref deletion via gh/GITHUB_TOKEN).",
48+
"Pruned 9 stale claude/* branches via the new workflow.",
3649
]
3750

3851
[maintenance-status]
39-
last-run-utc = "2026-03-21T00:00:00Z"
40-
last-result = "unknown" # unknown | pass | warn | fail
52+
last-run-utc = "2026-06-21T00:00:00Z"
53+
last-result = "warn" # green except upstream standards-pin CI failures

‎.machine_readable/anchors/ANCHOR.a2ml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
[metadata]
77
version = "1.0.0"
8-
last-updated = "{{CURRENT_DATE}}"
8+
last-updated = "2026-06-21"
99

1010
[anchor]
1111
schema = "hyperpolymath.anchor/1"
@@ -19,10 +19,10 @@ purpose = [
1919
]
2020

2121
[identity]
22-
project = "{{PROJECT_NAME}}"
23-
kind = "{{PROJECT_KIND}}" # language | library | service | tool
24-
one-sentence = "{{PROJECT_PURPOSE}}"
25-
domain = "{{PROJECT_DOMAIN}}"
22+
project = "wokelangiser"
23+
kind = "tool" # language | library | service | tool
24+
one-sentence = "Add consent patterns, accessibility annotations, i18n hooks, and cultural sensitivity markers to existing code via WokeLang"
25+
domain = "code-generation, compliance, accessibility"
2626

2727
[semantic-authority]
2828
policy = "canonical"

‎QUICKSTART-DEV.adoc‎

Lines changed: 49 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,23 @@
11
// SPDX-License-Identifier: CC-BY-SA-4.0
2-
// Template: QUICKSTART-DEV.adoc — clone → build → test → PR
3-
// Replace wokelangiser, {{BUILD_CMD}}, {{TEST_CMD}}, {{LANG_STACK}} with actuals
2+
// QUICKSTART-DEV.adoc — clone -> build -> test -> PR
43
= wokelangiser — Quick Start for Developers
54
:toc:
65
:toclevels: 2
76

87
== Tech Stack
98

10-
{{LANG_STACK}}
9+
* **Rust** — CLI host and codegen (`src/main.rs`, `src/codegen/`, `src/manifest/`)
10+
* **Idris2** — formal ABI proofs (`src/interface/abi/*.idr`)
11+
* **Zig** — C-ABI FFI bridge (`src/interface/ffi/`)
12+
* **Just** — task runner; **Guix/Nix** — reproducible dev environment
1113

1214
== Set Up Development Environment
1315

1416
=== Option A: Guix (preferred)
1517

1618
[source,bash]
1719
----
18-
guix shell
20+
guix shell -D -f guix.scm
1921
----
2022

2123
=== Option B: Nix (fallback)
@@ -31,81 +33,86 @@ nix develop
3133
----
3234
git clone https://github.com/hyperpolymath/wokelangiser.git
3335
cd wokelangiser
34-
just setup-dev
36+
just doctor # check required tools (just, git, cargo, ...)
3537
----
3638

39+
You will need a Rust toolchain (`cargo`) and — for the ABI/FFI layers — `idris2` and `zig`.
40+
3741
== Build
3842

3943
[source,bash]
4044
----
41-
{{BUILD_CMD}}
45+
just build # cargo build --release
4246
----
4347

4448
== Test
4549

4650
[source,bash]
4751
----
48-
{{TEST_CMD}}
52+
just test # cargo test
53+
# FFI tests:
54+
cd src/interface/ffi && zig build test
4955
----
5056

5157
== Project Structure
5258

5359
[source]
5460
----
5561
wokelangiser/
56-
├── src/ # Source code
57-
├── src/abi/ # Idris2 ABI definitions (if applicable)
58-
├── ffi/zig/ # Zig FFI bridge (if applicable)
59-
├── tests/ # Test suite
60-
├── docs/ # Documentation
61-
├── .machine_readable/ # Checkpoint files (STATE, META, ECOSYSTEM)
62-
├── Justfile # Task runner recipes
63-
├── guix.scm # Guix environment
64-
├── flake.nix # Nix environment (fallback)
65-
└── 0-AI-MANIFEST.a2ml # AI agent entry point
62+
├── src/main.rs # Rust CLI entry (init/validate/generate/build/run/info)
63+
├── src/manifest/ # wokelangiser.toml parser
64+
├── src/codegen/ # target-language emission (WIP — stubs)
65+
├── src/interface/abi/ # Idris2 ABI proofs (Types/Layout/Foreign)
66+
├── src/interface/ffi/ # Zig C-ABI bridge + tests
67+
├── docs/ # Human documentation (canonical)
68+
├── .machine_readable/ # Machine docs: 6a2/, contractiles/, anchors/
69+
├── Justfile # Task runner recipes
70+
├── guix.scm / flake.nix # Dev environments (Guix primary, Nix fallback)
71+
└── 0-AI-MANIFEST.a2ml # AI agent entry point
6672
----
6773

6874
== Key Recipes
6975

7076
[source,bash]
7177
----
72-
just build # Build the project
73-
just test # Run tests
74-
just doctor # Self-diagnostic
75-
just lint # Lint and format
76-
just panic-scan # Security scan via panic-attacker
77-
just tour # Guided tour of the codebase
78+
just # build + test (default)
79+
just build # release build
80+
just test # run tests
81+
just lint # clippy (-D warnings)
82+
just fmt # format
83+
just quality # fmt-check + lint + test
84+
just validate ARGS # validate a manifest
85+
just generate ARGS # run the codegen pipeline (WIP)
86+
just doctor # self-diagnostic
87+
just assail # panic-attacker security scan
88+
just tour # guided tour
7889
----
7990

91+
Run `just --list` to see every recipe.
92+
8093
== Before Submitting a PR
8194

8295
[source,bash]
8396
----
84-
just lint # Format and lint
85-
just test # All tests pass
86-
just panic-scan # No new security issues
97+
just quality # fmt-check + lint + test must pass
98+
just assail # no new security findings (if panic-attack installed)
8799
----
88100

89-
== Contractile Invariants
90-
91-
Read `.machine_readable/MUST.contractile` before making changes.
92-
Key invariants that must never be violated:
93-
94-
{{MUST_INVARIANTS}}
101+
Branch from `main`, use Conventional-Commits-style messages, then open a PR — see
102+
link:CONTRIBUTING.md[CONTRIBUTING.md].
95103

96-
== LLM/AI Agent Development
104+
== Contractile Invariants
97105

98-
If using an AI assistant, load the warmup context first:
106+
Before changing code, read the contractiles under `.machine_readable/contractiles/`
107+
— especially `must/Mustfile.a2ml` (critical invariants: no banned licences, no
108+
unsafe FFI, tests must pass). The matching CI gate is the Governance workflow.
99109

100-
[source,bash]
101-
----
102-
just llm-context # Outputs role-appropriate context
103-
----
110+
== LLM / AI Agent Development
104111

105-
Or read `0-AI-MANIFEST.a2ml` and `.claude/CLAUDE.md` directly.
112+
If using an AI assistant, load context first by reading `0-AI-MANIFEST.a2ml`
113+
(repo entry point) and `.claude/CLAUDE.md` (language and policy rules).
106114

107115
== Get Help
108116

109-
* **Architecture**: link:EXPLAINME.adoc[EXPLAINME.adoc]
110-
* **Wiki**: https://github.com/hyperpolymath/wokelangiser/wiki
111-
* **Report issue**: `just help-me`
117+
* **Architecture**: link:EXPLAINME.adoc[EXPLAINME.adoc] and link:docs/developer/ABI-FFI-README.adoc[docs/developer/ABI-FFI-README.adoc]
118+
* **Report an issue**: `just help-me`, or https://github.com/hyperpolymath/wokelangiser/issues

0 commit comments

Comments
 (0)