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
36 changes: 3 additions & 33 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,34 +1,4 @@
# SPDX-License-Identifier: MPL-2.0
# CODEOWNERS - Define code review assignments for GitHub
# See: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners

# Default: sole maintainer for all files
* @hyperpolymath

# Security-sensitive files require explicit ownership
SECURITY.md @hyperpolymath
.github/workflows/ @hyperpolymath
.machine_readable/ @hyperpolymath
contractiles/ @hyperpolymath

# License files
LICENSE @hyperpolymath
LICENSES/ @hyperpolymath

# Configuration
.gitignore @hyperpolymath
.github/ @hyperpolymath

# Documentation
README* @hyperpolymath
CONTRIBUTING* @hyperpolymath
CODE_OF_CONDUCT* @hyperpolymath
GOVERNANCE* @hyperpolymath
MAINTAINERS* @hyperpolymath
CHANGELOG* @hyperpolymath
ROADMAP* @hyperpolymath

# Build and CI
Justfile @hyperpolymath
Makefile @hyperpolymath
*.sh @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.
6 changes: 3 additions & 3 deletions .machine_readable/contractiles/Justfile
Original file line number Diff line number Diff line change
Expand Up @@ -385,8 +385,8 @@ container-init:
read -rp "Primary port [8080]: " _PORT
PORT="${_PORT:-8080}"

read -rp "Container registry [ghcr.io/${OWNER:-{{OWNER}}}]: " _REGISTRY
REGISTRY="${_REGISTRY:-ghcr.io/${OWNER:-{{OWNER}}}}"
read -rp "Container registry [ghcr.io/${OWNER:-hyperpolymath}]: " _REGISTRY
REGISTRY="${_REGISTRY:-ghcr.io/${OWNER:-hyperpolymath}}"

echo ""
echo " Service: $SERVICE_NAME"
Expand Down Expand Up @@ -601,7 +601,7 @@ test-matrix suite="unit" verbosity="normal" parallel="true":
@echo "Test matrix: suite={{suite}} verbosity={{verbosity}} parallel={{parallel}}"

# Container matrix: [build|run|push|shell|scan] x [registry] x [tag]
container-matrix action="build" registry="ghcr.io/{{OWNER}}" tag="latest":
container-matrix action="build" registry="ghcr.io/hyperpolymath" tag="latest":
@echo "Container matrix: action={{action}} registry={{registry}} tag={{tag}}"

# CI matrix: [lint|test|build|security|all] x [quick|full]
Expand Down
4 changes: 2 additions & 2 deletions ABI-FFI-README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
-->
{{~ Aditionally delete this line and fill out the template below ~}}

# {{PROJECT}} ABI/FFI Documentation
# CASKET_SSG ABI/FFI Documentation

## Overview

Expand Down Expand Up @@ -251,7 +251,7 @@ gcc -o example example.c -l{{project}} -L./zig-out/lib
### From Idris2

```idris
import {{PROJECT}}.ABI.Foreign
import CASKET_SSG.ABI.Foreign

main : IO ()
main = do
Expand Down
47 changes: 0 additions & 47 deletions ARCHITECTURE.md

This file was deleted.

8 changes: 4 additions & 4 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Replace all {{PLACEHOLDER}} values:
Polystack - Your project name
hyperpolymath - GitHub/GitLab username or org
polystack - Repository name
{{CONDUCT_EMAIL}} - Email for conduct reports
j.d.a.jewell@open.ac.uk - Email for conduct reports
{{CONDUCT_TEAM}} - Name of conduct team/committee
{{RESPONSE_TIME}} - Initial response SLA (e.g., 48 hours)
2026 - Current year
Expand Down Expand Up @@ -140,7 +140,7 @@ If you experience or witness unacceptable behaviour, or have any other concerns,

| Method | Details | Best For |
|--------|---------|----------|
| **Email** | {{CONDUCT_EMAIL}} | Detailed reports, sensitive matters |
| **Email** | j.d.a.jewell@open.ac.uk | Detailed reports, sensitive matters |
| **Private Message** | Contact any maintainer directly | Quick questions, minor issues |
| **Anonymous Form** | [Link to form if available] | When you need anonymity |

Expand Down Expand Up @@ -235,7 +235,7 @@ For contributors with elevated access (Perimeter 2 or 1):
If you believe an enforcement decision was made in error:

1. **Wait 7 days** after the decision (cooling-off period)
2. **Email** {{CONDUCT_EMAIL}} with subject line "Appeal: [Original Report ID]"
2. **Email** j.d.a.jewell@open.ac.uk with subject line "Appeal: [Original Report ID]"
3. **Explain** why you believe the decision should be reconsidered
4. **Provide** any new information not previously available

Expand Down Expand Up @@ -315,7 +315,7 @@ We thank these communities for their leadership in creating welcoming spaces.
If you have questions about this Code of Conduct:

- Open a [Discussion](https://github.com/hyperpolymath/polystack/discussions) (for general questions)
- Email {{CONDUCT_EMAIL}} (for private questions)
- Email j.d.a.jewell@open.ac.uk (for private questions)
- Contact any maintainer directly

---
Expand Down
6 changes: 3 additions & 3 deletions Justfile
Original file line number Diff line number Diff line change
Expand Up @@ -385,8 +385,8 @@ container-init:
read -rp "Primary port [8080]: " _PORT
PORT="${_PORT:-8080}"

read -rp "Container registry [ghcr.io/${OWNER:-{{OWNER}}}]: " _REGISTRY
REGISTRY="${_REGISTRY:-ghcr.io/${OWNER:-{{OWNER}}}}"
read -rp "Container registry [ghcr.io/${OWNER:-hyperpolymath}]: " _REGISTRY
REGISTRY="${_REGISTRY:-ghcr.io/${OWNER:-hyperpolymath}}"

echo ""
echo " Service: $SERVICE_NAME"
Expand Down Expand Up @@ -601,7 +601,7 @@ test-matrix suite="unit" verbosity="normal" parallel="true":
@echo "Test matrix: suite={{suite}} verbosity={{verbosity}} parallel={{parallel}}"

# Container matrix: [build|run|push|shell|scan] x [registry] x [tag]
container-matrix action="build" registry="ghcr.io/{{OWNER}}" tag="latest":
container-matrix action="build" registry="ghcr.io/hyperpolymath" tag="latest":
@echo "Container matrix: action={{action}} registry={{registry}} tag={{tag}}"

# CI matrix: [lint|test|build|security|all] x [quick|full]
Expand Down
77 changes: 77 additions & 0 deletions REQUIRES_INITIALISATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
<!-- SPDX-License-Identifier: CC-BY-SA-4.0 -->

# REQUIRES INITIALISATION

**This repository is not finished being set up.** 4 substitution token(s) across 4 file(s) still have no value.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Bug: Lowercase {{project}} tokens left unfilled in Zig FFI code

This PR filled the uppercase {{PROJECT}} comment tokens in ffi/zig/src/main.zig and ffi/zig/test/integration_test.zig but left the lowercase {{project}} tokens that appear in the actual export fn {{project}}_init(...) / extern fn {{project}}_init(...) identifiers (main.zig has ~11, integration_test.zig has ~30). These are not valid Zig identifiers, so both files fail to compile, and the FFI symbol names never get a real value. Worse, REQUIRES_INITIALISATION.md claims only 4 tokens remain ({{ARGS}}, {{CONDUCT_TEAM}}, {{KEY}}, {{RESPONSE_TIME}}) and omits {{project}} — a token with a purely mechanical answer (the project name) — so a maintainer following the checklist would delete the marker file with broken code still in the tree. Fill {{project}} with the canonical lowercase symbol prefix (e.g. casket_ssg) across both files, or add it to the tracked token inventory.

Was this helpful? React with 👍 / 👎


## 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:

- `.machine_readable/contractiles/Justfile`
- `Justfile`

### `{{CONDUCT_TEAM}}`

Name of the conduct body. If there is no committee, rewrite the sentence rather than substituting a plural noun into 'a {{CONDUCT_TEAM}} member'.

Appears in:

- `CODE_OF_CONDUCT.md`

### `{{KEY}}`

Appears in:

- `docs/guides/templates-and-theming.adoc`

### `{{RESPONSE_TIME}}`

Initial-response SLA for a security or conduct report. Promise only what a solo maintainer can actually meet.

Appears in:

- `CODE_OF_CONDUCT.md`

---

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`.
2 changes: 1 addition & 1 deletion ffi/zig/build.zig
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// SPDX-License-Identifier: MPL-2.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
// {{PROJECT}} FFI Build Configuration
// CASKET_SSG FFI Build Configuration

const std = @import("std");

Expand Down
4 changes: 2 additions & 2 deletions ffi/zig/src/main.zig
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// SPDX-License-Identifier: MPL-2.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
// {{PROJECT}} FFI Implementation
// CASKET_SSG FFI Implementation
//
// This module implements the C-compatible FFI declared in src/abi/Foreign.idr
// All types and layouts must match the Idris2 ABI definitions.
Expand All @@ -10,7 +10,7 @@ const std = @import("std");

// Version information (keep in sync with project)
const VERSION = "0.1.0";
const BUILD_INFO = "{{PROJECT}} built with Zig " ++ @import("builtin").zig_version_string;
const BUILD_INFO = "CASKET_SSG built with Zig " ++ @import("builtin").zig_version_string;

/// Thread-local error storage
threadlocal var last_error: ?[]const u8 = null;
Expand Down
2 changes: 1 addition & 1 deletion ffi/zig/test/integration_test.zig
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// SPDX-License-Identifier: MPL-2.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
// {{PROJECT}} Integration Tests
// CASKET_SSG Integration Tests
//
// These tests verify that the Zig FFI correctly implements the Idris2 ABI

Expand Down