Skip to content

Commit 876be40

Browse files
committed
chore: fill derivable placeholders, drop false ARCHITECTURE, surface the rest
Estate top-up pass. Three separate things, none of which invents a value. FILLED — every token with a single mechanical answer: OWNER, REPO, FORGE, PROJECT, PACKAGE_NAME, PROJECT_NAME, AUTHOR, AUTHOR_EMAIL, CONDUCT_EMAIL, AUTHOR_FIRST/LAST/INITIALS, CURRENT_YEAR, CURRENT_DATE, DATE, MAIN_BRANCH. Identity comes from the git remote, dates from the clock, project name from the README H1 where there is one. Deliberately NOT filled, because more than one defensible answer exists and a confident wrong value is worse than a visible gap: SECURITY_EMAIL (two competing addresses are in use across the estate), RESPONSE_TIME, CONDUCT_TEAM (which substitutes into "a {{CONDUCT_TEAM}} member", not English), WEBSITE, PROJECT_DESCRIPTION, LANG_STACK. DELETED — ARCHITECTURE.md, where it is byte-identical to the 346-copy estate boilerplate (blob 607e3d8). Those 33 lines describe a src/ tests/ docs/ scripts/ config/ tree that this repo does not have, so the file is not merely uninformative, it is wrong. Genuinely written ARCHITECTURE files are matched by hash and left alone. No file beats a confidently false one. CODEOWNERS — rewritten to the solo form mandated by hyperpolymath/standards CODEOWNERS-POLICY.adoc Rule 1, which forbids a catch-all line where the only owner is the sole maintainer. The estate's own templates/CODEOWNERS contradicts that policy; the policy is versioned, dated and resolves standards#55, so it wins. Files naming a genuine co-owner are Rule 2 and are untouched. Note @hyperpolymath and @metadatastician are the same person, so a file naming the other account is a copy artifact that silently routed review requests to the wrong account. SURFACED — REQUIRES_INITIALISATION.md, and a priority action in 0-AI-MANIFEST.a2ml. Tokens that need a decision no script can make are left visibly unfilled rather than faked or quietly deleted. The marker says what each one is, which files it belongs in, why it was not done already, and that it must be deleted only once the work is genuinely finished.
1 parent f0d8231 commit 876be40

6 files changed

Lines changed: 131 additions & 89 deletions

File tree

.github/CODEOWNERS

Lines changed: 3 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,4 @@
11
# SPDX-License-Identifier: MPL-2.0
2-
# CODEOWNERS - Define code review assignments for GitHub
3-
# See: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
4-
5-
# Default: sole maintainer for all files
6-
* @hyperpolymath
7-
8-
# Security-sensitive files require explicit ownership
9-
SECURITY.md @hyperpolymath
10-
.github/workflows/ @hyperpolymath
11-
.machine_readable/ @hyperpolymath
12-
contractiles/ @hyperpolymath
13-
14-
# License files
15-
LICENSE @hyperpolymath
16-
LICENSES/ @hyperpolymath
17-
18-
# Configuration
19-
.gitignore @hyperpolymath
20-
.github/ @hyperpolymath
21-
22-
# Documentation
23-
README* @hyperpolymath
24-
CONTRIBUTING* @hyperpolymath
25-
CODE_OF_CONDUCT* @hyperpolymath
26-
GOVERNANCE* @hyperpolymath
27-
MAINTAINERS* @hyperpolymath
28-
CHANGELOG* @hyperpolymath
29-
ROADMAP* @hyperpolymath
30-
31-
# Build and CI
32-
Justfile @hyperpolymath
33-
Makefile @hyperpolymath
34-
*.sh @hyperpolymath
2+
# Solo-maintained hyperpolymath repo: no owner lines by policy.
3+
# See hyperpolymath/standards CODEOWNERS-POLICY.adoc (Rule 1).
4+
# Sole-maintainer review is moot; SPDX headers carry attribution.

.machine_readable/bot_directives/methodology.a2ml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ constraints = [
101101
# These rules detect corrupt/template/stale state files.
102102

103103
[methodology.state-validation]
104-
reject-if-contains = ["{{PLACEHOLDER}}", "{{PROJECT}}", "rsr-template-repo"]
104+
reject-if-contains = ["{{PLACEHOLDER}}", "SCRIPTS", "rsr-template-repo"]
105105
reject-if-project-name-mismatch = true
106106
staleness-threshold-days = 90
107107
fallback-files = ["TODO.md", "TODO.adoc", "ROADMAP.adoc", "README.adoc"]

0-AI-MANIFEST.a2ml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,20 @@
1313
## Delivery Promises
1414
- Mention in summaries whether STATE, `contractiles/`, or `.bot_directives/` changed.
1515
- Keep this file in sync with the repository’s status; update it if the governance changes.
16+
17+
<!-- BEGIN requires-initialisation -->
18+
19+
## PRIORITY ACTION — this repository is not fully initialised
20+
21+
7 substitution token(s) still have no value. **Read
22+
`REQUIRES_INITIALISATION.md` in the repository root before doing anything
23+
else here** — it lists every outstanding token, what it means, and which
24+
files it belongs in.
25+
26+
Do not fabricate values for them, and do not delete the sections that
27+
contain them to quiet a gate. They are unfilled because they need a
28+
decision, not because they were overlooked. Resolve what you legitimately
29+
can, leave the rest, and delete `REQUIRES_INITIALISATION.md` only when
30+
nothing outstanding remains.
31+
32+
<!-- END requires-initialisation -->

ARCHITECTURE.md

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

QUICKSTART-MAINTAINER.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// SPDX-License-Identifier: CC-BY-SA-4.0
22
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
33
// Template: QUICKSTART-MAINTAINER.adoc — packaging, deploying, and maintaining
4-
// Replace scripts, {{PACKAGE_NAME}}, {{DEPS}} with actuals
4+
// Replace scripts, scripts, {{DEPS}} with actuals
55
= scripts — Quick Start for Platform Maintainers
66
:toc:
77
:toclevels: 2
@@ -66,10 +66,10 @@ Files installed:
6666
| `$PREFIX/bin/`
6767
| Executables
6868

69-
| `$PREFIX/share/{{PACKAGE_NAME}}/`
69+
| `$PREFIX/share/scripts/`
7070
| Data files, assets
7171

72-
| `$PREFIX/share/doc/{{PACKAGE_NAME}}/`
72+
| `$PREFIX/share/doc/scripts/`
7373
| Documentation
7474

7575
| `$PREFIX/share/applications/`
@@ -81,9 +81,9 @@ Files installed:
8181

8282
== Configuration
8383

84-
Default config location: `$XDG_CONFIG_HOME/{{PACKAGE_NAME}}/config.toml`
84+
Default config location: `$XDG_CONFIG_HOME/scripts/config.toml`
8585

86-
Fallback: `$HOME/.config/{{PACKAGE_NAME}}/config.toml`
86+
Fallback: `$HOME/.config/scripts/config.toml`
8787

8888
== Health Checks
8989

@@ -103,7 +103,7 @@ just build-release
103103
just install --prefix=/usr/local
104104
----
105105

106-
Or via OPSM: `opsm update {{PACKAGE_NAME}}`
106+
Or via OPSM: `opsm update scripts`
107107

108108
== Security Notes
109109

@@ -118,8 +118,8 @@ For deploying multiple instances (e.g., different users or tenants):
118118

119119
[source,bash]
120120
----
121-
just install --prefix=/opt/{{PACKAGE_NAME}}-instance1 --config=/etc/{{PACKAGE_NAME}}/instance1.toml
122-
just install --prefix=/opt/{{PACKAGE_NAME}}-instance2 --config=/etc/{{PACKAGE_NAME}}/instance2.toml
121+
just install --prefix=/opt/scripts-instance1 --config=/etc/scripts/instance1.toml
122+
just install --prefix=/opt/scripts-instance2 --config=/etc/scripts/instance2.toml
123123
----
124124

125125
Each instance has isolated config, data, and logs.

REQUIRES_INITIALISATION.md

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
<!-- SPDX-License-Identifier: CC-BY-SA-4.0 -->
2+
3+
# REQUIRES INITIALISATION
4+
5+
**This repository is not finished being set up.** 7 substitution token(s) across 3 file(s) still have no value.
6+
7+
## Why this is not already done
8+
9+
This repo was created from `hyperpolymath/rsr-template-repo`. The mint
10+
(`just repo-init`) fills every token that has a single mechanical answer —
11+
owner, repo, author, dates, licence, branch — and it has done so here.
12+
13+
The tokens below are the ones it *deliberately cannot* answer. They need a
14+
decision or a fact that exists only in your head: what this project is for,
15+
what command builds it, which port the service listens on, whether a PGP key
16+
is held at all. The template's own token vocabulary says as much — you cannot
17+
sensibly answer "required invariants" in a thirty-second bootstrap.
18+
19+
They were left **visibly unfilled on purpose**. The alternatives were both
20+
worse: inventing plausible values would put confident falsehoods into a
21+
security policy and an architecture document, and silently deleting the
22+
sections would hide the fact that a decision is owed. A visible gap is
23+
honest; a fabricated answer is not.
24+
25+
## Do not delete this file until every item below is resolved
26+
27+
This file is the only marker that the work is outstanding. Deleting it early
28+
does not finish the setup, it just conceals it — and the next person or agent
29+
to arrive will reasonably assume the repo is complete.
30+
31+
- **If you are a person:** delete this file yourself once the last item is done.
32+
- **If you are an agent:** resolve what you legitimately can, leave the rest,
33+
and delete this file only when no token below remains anywhere in the tree.
34+
Do not delete it to make a gate go green.
35+
36+
Re-running the estate top-up tool will remove this file automatically once
37+
nothing is outstanding, so the safest way to finish is to fix the tokens and
38+
let the check confirm it.
39+
40+
## What is needed, and where it goes
41+
42+
### `{{BUILD_CMD}}`
43+
44+
The exact command that builds this project.
45+
46+
Appears in:
47+
48+
- `QUICKSTART-DEV.adoc`
49+
50+
### `{{BUILD_OUTPUT_PATH}}`
51+
52+
Where the build artefact lands.
53+
54+
Appears in:
55+
56+
- `QUICKSTART-MAINTAINER.adoc`
57+
58+
### `{{DEPS}}`
59+
60+
Prose summary of runtime/build dependencies.
61+
62+
Appears in:
63+
64+
- `QUICKSTART-MAINTAINER.adoc`
65+
66+
### `{{LANG_STACK}}`
67+
68+
The language stack, in prose.
69+
70+
Appears in:
71+
72+
- `QUICKSTART-DEV.adoc`
73+
74+
### `{{MUST_INVARIANTS}}`
75+
76+
The invariants this project guarantees. Not answerable in a bootstrap; it is the point of the repo.
77+
78+
Appears in:
79+
80+
- `QUICKSTART-DEV.adoc`
81+
82+
### `{{PROJECT_UNIQUE_STRENGTH}}`
83+
84+
What this does that its alternatives do not.
85+
86+
Appears in:
87+
88+
- `.machine_readable/bot_directives/methodology.a2ml`
89+
90+
### `{{TEST_CMD}}`
91+
92+
The exact command that runs its tests.
93+
94+
Appears in:
95+
96+
- `QUICKSTART-DEV.adoc`
97+
98+
---
99+
100+
Generated by the estate top-up pass. Rationale and the governing rulings are
101+
in `hyperpolymath/standards`; the token vocabulary is
102+
`.machine_readable/ai/PLACEHOLDERS.adoc` in `rsr-template-repo`.

0 commit comments

Comments
 (0)