-
-
Notifications
You must be signed in to change notification settings - Fork 0
chore: fill derivable placeholders, drop false ARCHITECTURE, surface the rest #61
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,4 @@ | ||
| # SPDX-License-Identifier: MPL-2.0 | ||
| # CODEOWNERS - Define code review assignments | ||
| # See: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners | ||
| # | ||
| # Replace hyperpolymath with your GitHub username or team | ||
|
|
||
| # Default owners for everything | ||
| * @hyperpolymath | ||
|
|
||
| # Security-sensitive files require explicit review | ||
| SECURITY.md @hyperpolymath | ||
| .github/workflows/ @hyperpolymath | ||
| Trustfile.a2ml @hyperpolymath | ||
| .machine_readable/ @hyperpolymath | ||
| # Solo-maintained hyperpolymath repo: no owner lines by policy. | ||
| # See hyperpolymath/standards CODEOWNERS-POLICY.adoc (Rule 1). | ||
| # Sole-maintainer review is moot; SPDX headers carry attribution. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,148 @@ | ||
| <!-- SPDX-License-Identifier: CC-BY-SA-4.0 --> | ||
|
|
||
| # REQUIRES INITIALISATION | ||
|
|
||
| **This repository is not finished being set up.** 12 substitution token(s) across 14 file(s) still have no value. | ||
|
|
||
| ## Why this is not already done | ||
|
|
||
| This repo was created from `hyperpolymath/rsr-template-repo`. The mint | ||
| (`just repo-init`) fills every token that has a single mechanical answer — | ||
| owner, repo, author, dates, licence, branch — and it has done so here. | ||
|
|
||
| The tokens below are the ones it *deliberately cannot* answer. They need a | ||
| decision or a fact that exists only in your head: what this project is for, | ||
| what command builds it, which port the service listens on, whether a PGP key | ||
| is held at all. The template's own token vocabulary says as much — you cannot | ||
| sensibly answer "required invariants" in a thirty-second bootstrap. | ||
|
|
||
| They were left **visibly unfilled on purpose**. The alternatives were both | ||
| worse: inventing plausible values would put confident falsehoods into a | ||
| security policy and an architecture document, and silently deleting the | ||
| sections would hide the fact that a decision is owed. A visible gap is | ||
| honest; a fabricated answer is not. | ||
|
|
||
| ## Do not delete this file until every item below is resolved | ||
|
|
||
| This file is the only marker that the work is outstanding. Deleting it early | ||
| does not finish the setup, it just conceals it — and the next person or agent | ||
| to arrive will reasonably assume the repo is complete. | ||
|
|
||
| - **If you are a person:** delete this file yourself once the last item is done. | ||
| - **If you are an agent:** resolve what you legitimately can, leave the rest, | ||
| and delete this file only when no token below remains anywhere in the tree. | ||
| Do not delete it to make a gate go green. | ||
|
|
||
| Re-running the estate top-up tool will remove this file automatically once | ||
| nothing is outstanding, so the safest way to finish is to fix the tokens and | ||
| let the check confirm it. | ||
|
|
||
| ## What is needed, and where it goes | ||
|
|
||
| ### `{{ARGS}}` | ||
|
|
||
| Arguments for the justfile recipe this appears in. | ||
|
|
||
| Appears in: | ||
|
|
||
| - `Justfile` | ||
|
|
||
| ### `{{CONSUMER1}}` | ||
|
|
||
| A downstream repo that consumes this one. | ||
|
|
||
| Appears in: | ||
|
|
||
| - `.machine_readable/INTENT.contractile` | ||
|
|
||
| ### `{{CONSUMER2}}` | ||
|
|
||
| A second downstream consumer. | ||
|
|
||
| Appears in: | ||
|
|
||
| - `.machine_readable/INTENT.contractile` | ||
|
|
||
| ### `{{DEP1}}` | ||
|
|
||
| First named dependency, in .machine_readable/INTENT.contractile. | ||
|
|
||
| Appears in: | ||
|
|
||
| - `.machine_readable/INTENT.contractile` | ||
|
|
||
| ### `{{DEP2}}` | ||
|
|
||
| Second named dependency, in .machine_readable/INTENT.contractile. | ||
|
|
||
| Appears in: | ||
|
|
||
| - `.machine_readable/INTENT.contractile` | ||
|
|
||
| ### `{{DEPS}}` | ||
|
|
||
| Prose summary of runtime/build dependencies. | ||
|
|
||
| Appears in: | ||
|
|
||
| - `docs/onboarding/QUICKSTART-MAINTAINER.adoc` | ||
|
|
||
| ### `{{OPENSSF_PROJECT_ID}}` | ||
|
|
||
| OpenSSF project ID, same registration. | ||
|
|
||
| Appears in: | ||
|
|
||
| - `docs/governance/TEMPLATE-STANDARDS-AUDIT.adoc` | ||
|
|
||
| ### `{{PGP_FINGERPRINT}}` | ||
|
|
||
| Full fingerprint of the security-contact PGP key. NOTE: no key is published anywhere in this estate — if none is held, delete the PGP block rather than inventing one. | ||
|
|
||
| Appears in: | ||
|
|
||
| - `.github/SECURITY.md` | ||
|
|
||
| ### `{{PGP_KEY_URL}}` | ||
|
|
||
| Public URL the PGP key can be fetched from. Same caveat as PGP_FINGERPRINT. | ||
|
|
||
| Appears in: | ||
|
|
||
| - `.github/SECURITY.md` | ||
| - `.well-known/security.txt` | ||
|
|
||
| ### `{{PORT}}` | ||
|
|
||
| Port the container service listens on. | ||
|
|
||
| Appears in: | ||
|
|
||
| - `container/Containerfile` | ||
| - `container/compose.toml` | ||
| - `container/deploy.k9.ncl` | ||
| - `container/entrypoint.sh` | ||
| - `container/manifest.toml` | ||
| - `container/vordr.toml` | ||
|
|
||
| ### `{{REGISTRY}}` | ||
|
|
||
| Container registry to publish to. | ||
|
|
||
| Appears in: | ||
|
|
||
| - `container/compose.toml` | ||
| - `container/ct-build.sh` | ||
| - `container/deploy.k9.ncl` | ||
|
|
||
| ### `{{REPO_DESCRIPTION}}` | ||
|
|
||
| Appears in: | ||
|
|
||
| - `.machine_readable/ECOSYSTEM.a2ml` | ||
|
|
||
| --- | ||
|
|
||
| Generated by the estate top-up pass. Rationale and the governing rulings are | ||
| in `hyperpolymath/standards`; the token vocabulary is | ||
| `.machine_readable/ai/PLACEHOLDERS.adoc` in `rsr-template-repo`. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 Quality: {{ARGS}} listed as an unfilled token, but it is valid just syntax
{{ARGS}}in the Justfile is the interpolation of the*ARGSparameter of theinvariant-pathrecipe (invariant-path *ARGS:→./scripts/invariant-path.sh {{ARGS}}), not an uninitialised substitution placeholder. The top-up tool swept it up, inflating the reported count and instructing readers/agents to 'fill' it; acting on that would break the recipe. Remove the{{ARGS}}entry (and adjust the '12 token' count here and in 0-AI-MANIFEST.a2ml) so the detector ignores just recipe parameters.Was this helpful? React with 👍 / 👎