|
| 1 | +<!-- SPDX-License-Identifier: CC-BY-SA-4.0 --> |
| 2 | + |
| 3 | +# REQUIRES INITIALISATION |
| 4 | + |
| 5 | +**This repository is not finished being set up.** 16 substitution token(s) across 5 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 | +- `docs/reports/audit/pillar-audit-2026-04-15.md` |
| 57 | + |
| 58 | +### `{{CONDUCT_TEAM}}` |
| 59 | + |
| 60 | +Name of the conduct body. If there is no committee, rewrite the sentence rather than substituting a plural noun into 'a {{CONDUCT_TEAM}} member'. |
| 61 | + |
| 62 | +Appears in: |
| 63 | + |
| 64 | +- `CHANGELOG.md` |
| 65 | + |
| 66 | +### `{{CONSUMER1}}` |
| 67 | + |
| 68 | +A downstream repo that consumes this one. |
| 69 | + |
| 70 | +Appears in: |
| 71 | + |
| 72 | +- `.machine_readable/INTENT.contractile` |
| 73 | + |
| 74 | +### `{{CONSUMER2}}` |
| 75 | + |
| 76 | +A second downstream consumer. |
| 77 | + |
| 78 | +Appears in: |
| 79 | + |
| 80 | +- `.machine_readable/INTENT.contractile` |
| 81 | + |
| 82 | +### `{{DEP1}}` |
| 83 | + |
| 84 | +First named dependency, in .machine_readable/INTENT.contractile. |
| 85 | + |
| 86 | +Appears in: |
| 87 | + |
| 88 | +- `.machine_readable/INTENT.contractile` |
| 89 | + |
| 90 | +### `{{DEP2}}` |
| 91 | + |
| 92 | +Second named dependency, in .machine_readable/INTENT.contractile. |
| 93 | + |
| 94 | +Appears in: |
| 95 | + |
| 96 | +- `.machine_readable/INTENT.contractile` |
| 97 | + |
| 98 | +### `{{DEPS}}` |
| 99 | + |
| 100 | +Prose summary of runtime/build dependencies. |
| 101 | + |
| 102 | +Appears in: |
| 103 | + |
| 104 | +- `docs/reports/audit/pillar-audit-2026-04-15.md` |
| 105 | + |
| 106 | +### `{{LANG_STACK}}` |
| 107 | + |
| 108 | +The language stack, in prose. |
| 109 | + |
| 110 | +Appears in: |
| 111 | + |
| 112 | +- `QUICKSTART-DEV.adoc` |
| 113 | + |
| 114 | +### `{{MONOREPO_OR_STANDALONE}}` |
| 115 | + |
| 116 | +Literally 'monorepo' or 'standalone'. |
| 117 | + |
| 118 | +Appears in: |
| 119 | + |
| 120 | +- `.machine_readable/INTENT.contractile` |
| 121 | + |
| 122 | +### `{{MUST_INVARIANTS}}` |
| 123 | + |
| 124 | +The invariants this project guarantees. Not answerable in a bootstrap; it is the point of the repo. |
| 125 | + |
| 126 | +Appears in: |
| 127 | + |
| 128 | +- `QUICKSTART-DEV.adoc` |
| 129 | + |
| 130 | +### `{{ONE_PARAGRAPH_ANTI_PURPOSE}}` |
| 131 | + |
| 132 | +A paragraph on what this deliberately is NOT for. |
| 133 | + |
| 134 | +Appears in: |
| 135 | + |
| 136 | +- `.machine_readable/INTENT.contractile` |
| 137 | + |
| 138 | +### `{{ONE_PARAGRAPH_PURPOSE}}` |
| 139 | + |
| 140 | +A paragraph on what this is for. |
| 141 | + |
| 142 | +Appears in: |
| 143 | + |
| 144 | +- `.machine_readable/INTENT.contractile` |
| 145 | + |
| 146 | +### `{{PROJECT_UNIQUE_STRENGTH}}` |
| 147 | + |
| 148 | +What this does that its alternatives do not. |
| 149 | + |
| 150 | +Appears in: |
| 151 | + |
| 152 | +- `.machine_readable/agent_instructions/methodology.a2ml` |
| 153 | + |
| 154 | +### `{{RESPONSE_TIME}}` |
| 155 | + |
| 156 | +Initial-response SLA for a security or conduct report. Promise only what a solo maintainer can actually meet. |
| 157 | + |
| 158 | +Appears in: |
| 159 | + |
| 160 | +- `CHANGELOG.md` |
| 161 | + |
| 162 | +### `{{TEST_CMD}}` |
| 163 | + |
| 164 | +The exact command that runs its tests. |
| 165 | + |
| 166 | +Appears in: |
| 167 | + |
| 168 | +- `QUICKSTART-DEV.adoc` |
| 169 | + |
| 170 | +--- |
| 171 | + |
| 172 | +Generated by the estate top-up pass. Rationale and the governing rulings are |
| 173 | +in `hyperpolymath/standards`; the token vocabulary is |
| 174 | +`.machine_readable/ai/PLACEHOLDERS.adoc` in `rsr-template-repo`. |
0 commit comments