Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 4 additions & 9 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
# Code Owners

# Default: All contributors with write access are code owners
* @metadatastician

# For specific paths, add explicit owners below
# Example:
# /src/* @team-lead
# /docs/* @docs-maintainer
# SPDX-License-Identifier: MPL-2.0
# 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.
2 changes: 1 addition & 1 deletion .machine_readable/agent_instructions/methodology.a2ml
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ constraints = [
# These rules detect corrupt/template/stale state files.

[methodology.state-validation]
reject-if-contains = ["{{PLACEHOLDER}}", "{{PROJECT}}", "rsr-template-repo"]
reject-if-contains = ["{{PLACEHOLDER}}", "INTSOC_TRANSACTOR", "rsr-template-repo"]
reject-if-project-name-mismatch = true
staleness-threshold-days = 90
fallback-files = ["TODO.md", "TODO.adoc", "ROADMAP.adoc", "README.adoc"]
17 changes: 17 additions & 0 deletions 0-AI-MANIFEST.a2ml
Original file line number Diff line number Diff line change
Expand Up @@ -129,3 +129,20 @@ intsoc-transactor/
- **Maintained By:** Jonathan D.A. Jewell (hyperpolymath)
- **License:** MPL-2.0
- **Protocol:** https://github.com/hyperpolymath/0-ai-gatekeeper-protocol

<!-- BEGIN requires-initialisation -->

## PRIORITY ACTION — this repository is not fully initialised

39 substitution token(s) still have no value. **Read
`REQUIRES_INITIALISATION.md` in the repository root before doing anything
else here** — it lists every outstanding token, what it means, and which
files it belongs in.

Do not fabricate values for them, and do not delete the sections that
contain them to quiet a gate. They are unfilled because they need a
decision, not because they were overlooked. Resolve what you legitimately
can, leave the rest, and delete `REQUIRES_INITIALISATION.md` only when
nothing outstanding remains.

<!-- END requires-initialisation -->
47 changes: 0 additions & 47 deletions ARCHITECTURE.md

This file was deleted.

14 changes: 7 additions & 7 deletions PLACEHOLDERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ sed -i 's/Jonathan D.A. Jewell/Jane Doe/g' $(grep -rl 'Jonathan D.A. Jewell' .)
sed -i 's/j.d.a.jewell@open.ac.uk/jane@example.org/g' $(grep -rl 'j.d.a.jewell@open.ac.uk' .)
sed -i 's/hyperpolymath/my-org/g' $(grep -rl 'hyperpolymath' .)
sed -i 's/Intsoc Transactor/my-project/g' $(grep -rl 'Intsoc Transactor' .)
sed -i 's/{{PROJECT}}/MY_PROJECT/g' $(grep -rl '{{PROJECT}}' .)
sed -i 's/INTSOC_TRANSACTOR/MY_PROJECT/g' $(grep -rl 'INTSOC_TRANSACTOR' .)
sed -i 's/{{project}}/my_project/g' $(grep -rl '{{project}}' .)
sed -i 's/intsoc-transactor/my-project/g' $(grep -rl 'intsoc-transactor' .)
sed -i 's/github.com/github.com/g' $(grep -rl 'github.com' .)
Expand All @@ -39,17 +39,17 @@ sed -i "s/2026-03-16/$(date +%Y-%m-%d)/g" $(grep -rl '2026-03-16' .)
| `j.d.a.jewell@open.ac.uk` | Primary contact email | `jane@example.org` | SPDX headers (all files), .mailmap, .reuse/dep5, .well-known/humans.txt |
| `{{AUTHOR_EMAIL_ALT}}` | Previous/secondary email (for .mailmap) | `old@example.com` | .mailmap |
| `{{AUTHOR_ORG}}` | Author's organization/affiliation | `Acme University` | project-metadata.k9.ncl |
| `{{AUTHOR_LAST}}` | Author surname (for citations) | `Doe` | docs/CITATIONS.adoc |
| `{{AUTHOR_FIRST}}` | Author first name (for citations) | `Jane` | docs/CITATIONS.adoc |
| `{{AUTHOR_INITIALS}}` | Author initials (for citations) | `J.` | docs/CITATIONS.adoc |
| `Jewell` | Author surname (for citations) | `Doe` | docs/CITATIONS.adoc |
| `Jonathan` | Author first name (for citations) | `Jane` | docs/CITATIONS.adoc |
| `JDJ` | Author initials (for citations) | `J.` | docs/CITATIONS.adoc |

### Project Identity

| Placeholder | Description | Example | Files |
|---|---|---|---|
| `Intsoc Transactor` | Human-readable project name | `My Project` | SECURITY.md, CODE_OF_CONDUCT.md, TOPOLOGY.md, STATE.a2ml, Justfile, GOVERNANCE.md, MAINTAINERS.md, flake.nix, devcontainer.json |
| `{{PROJECT_DESCRIPTION}}` | One-line description | `A tool for X` | flake.nix |
| `{{PROJECT}}` | Uppercase identifier (for Idris2 modules, C macros) | `MY_PROJECT` | ABI-FFI-README.md, src/abi/*.idr, ffi/zig/*.zig |
| `INTSOC_TRANSACTOR` | Uppercase identifier (for Idris2 modules, C macros) | `MY_PROJECT` | ABI-FFI-README.md, src/abi/*.idr, ffi/zig/*.zig |
| `{{project}}` | Lowercase identifier (for C symbols, filenames) | `my_project` | ABI-FFI-README.md, ffi/zig/*.zig |
| `intsoc-transactor` | Repository name (slug) | `my-project` | CONTRIBUTING.md, SECURITY.md, CODE_OF_CONDUCT.md, cliff.toml |
| `hyperpolymath` | GitHub/GitLab org or username | `my-org` | SPDX headers, CONTRIBUTING.md, SECURITY.md, GOVERNANCE.md, MAINTAINERS.md, CODEOWNERS, mirror.yml, cliff.toml |
Expand All @@ -61,7 +61,7 @@ sed -i "s/2026-03-16/$(date +%Y-%m-%d)/g" $(grep -rl '2026-03-16' .)
|---|---|---|---|
| `2026` | Current year | `2026` | SPDX headers (all files), GOVERNANCE.md, MAINTAINERS.md |
| `2026-03-16` | Current date (ISO) | `2026-02-14` | STATE.a2ml, MAINTAINERS.md |
| `{{DATE}}` | Last updated date | `2026-02-14` | TOPOLOGY.md, THREAT-MODEL.md |
| `2026-08-05` | Last updated date | `2026-02-14` | TOPOLOGY.md, THREAT-MODEL.md |

### Contact & Security

Expand All @@ -71,7 +71,7 @@ sed -i "s/2026-03-16/$(date +%Y-%m-%d)/g" $(grep -rl '2026-03-16' .)
| `[PGP fingerprint not set]` | 40-char PGP fingerprint | `ABCD 1234 ...` | SECURITY.md |
| `{{PGP_KEY_URL}}` | URL to public PGP key | `https://keys.openpgp.org/...` | SECURITY.md |
| `{{WEBSITE}}` | Project website | `https://example.org` | SECURITY.md |
| `{{CONDUCT_EMAIL}}` | Conduct reports email | `conduct@example.org` | CODE_OF_CONDUCT.md |
| `j.d.a.jewell@open.ac.uk` | Conduct reports email | `conduct@example.org` | CODE_OF_CONDUCT.md |
| `{{CONDUCT_TEAM}}` | Conduct committee name | `Code of Conduct Committee` | CODE_OF_CONDUCT.md |
| `{{RESPONSE_TIME}}` | SLA for initial response | `48 hours` | CODE_OF_CONDUCT.md |

Expand Down
16 changes: 8 additions & 8 deletions QUICKSTART-MAINTAINER.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Template: QUICKSTART-MAINTAINER.adoc — packaging, deploying, and maintaining
// Replace intsoc-transactor, {{PACKAGE_NAME}}, {{DEPS}} with actuals
// Replace intsoc-transactor, intsoc-transactor, {{DEPS}} with actuals
= intsoc-transactor — Quick Start for Platform Maintainers
:toc:
:toclevels: 2
Expand Down Expand Up @@ -65,10 +65,10 @@ Files installed:
| `$PREFIX/bin/`
| Executables

| `$PREFIX/share/{{PACKAGE_NAME}}/`
| `$PREFIX/share/intsoc-transactor/`
| Data files, assets

| `$PREFIX/share/doc/{{PACKAGE_NAME}}/`
| `$PREFIX/share/doc/intsoc-transactor/`
| Documentation

| `$PREFIX/share/applications/`
Expand All @@ -80,9 +80,9 @@ Files installed:

== Configuration

Default config location: `$XDG_CONFIG_HOME/{{PACKAGE_NAME}}/config.toml`
Default config location: `$XDG_CONFIG_HOME/intsoc-transactor/config.toml`

Fallback: `$HOME/.config/{{PACKAGE_NAME}}/config.toml`
Fallback: `$HOME/.config/intsoc-transactor/config.toml`

== Health Checks

Expand All @@ -102,7 +102,7 @@ just build-release
just install --prefix=/usr/local
----

Or via OPSM: `opsm update {{PACKAGE_NAME}}`
Or via OPSM: `opsm update intsoc-transactor`

== Security Notes

Expand All @@ -117,8 +117,8 @@ For deploying multiple instances (e.g., different users or tenants):

[source,bash]
----
just install --prefix=/opt/{{PACKAGE_NAME}}-instance1 --config=/etc/{{PACKAGE_NAME}}/instance1.toml
just install --prefix=/opt/{{PACKAGE_NAME}}-instance2 --config=/etc/{{PACKAGE_NAME}}/instance2.toml
just install --prefix=/opt/intsoc-transactor-instance1 --config=/etc/intsoc-transactor/instance1.toml
just install --prefix=/opt/intsoc-transactor-instance2 --config=/etc/intsoc-transactor/instance2.toml
----

Each instance has isolated config, data, and logs.
Expand Down
Loading
Loading