Skip to content

Commit a3b76a3

Browse files
chore(governance): land missing docs/packaging before the standards#505 gates bite (#83)
Remediates this repo against the two governance gates promoted from advisory to blocking in [hyperpolymath/standards#513](hyperpolymath/standards#513) (closing standards#505). Those gates previously **could not fail**: the docs check only emitted `::warning::`, and the package-policy job ended in an unconditional `✅ Package policy check passed`. They are now real, with a grace window — they begin **blocking on 2026-08-21**. This repo was measured as non-compliant, so this PR lands the missing files ahead of that date. **Added here:** `CONTRIBUTING` ### `CONTRIBUTING.md` Markdown by estate rule (it is on the GitHub-required community-health list, unlike `README.adoc`). Content is derived from this repo, not boilerplate: the build section lists **only `just` recipes that actually exist here**, and the A2ML section appears only if `.machine_readable/` is present. --- Part of an estate-wide sweep; 63 repos were identified as non-compliant. Third-party/forked repos (`HOL`, `awesome-*`, `lua-filters`) were **excluded** per the licence policy's do-not-touch rule. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
1 parent bbae2df commit a3b76a3

1 file changed

Lines changed: 51 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
<!-- SPDX-License-Identifier: MPL-2.0 -->
2+
<!-- SPDX-FileCopyrightText: 2026 Jonathan D.A. Jewell -->
3+
4+
# Contributing to protocol-squisher
5+
6+
Thanks for your interest. This repository follows the Hyperpolymath estate
7+
standards defined in [hyperpolymath/standards](https://github.com/hyperpolymath/standards).
8+
9+
## Licence
10+
11+
This project is licensed under **MPL-2.0**. By contributing you agree that
12+
your contributions are licensed under the same terms. Every source file
13+
carries an `SPDX-License-Identifier` header; keep it when editing, and add
14+
one to any new file.
15+
16+
## Development environment
17+
18+
Use the toolchain declared by this repository.
19+
20+
## Machine-readable artefacts
21+
22+
This repo carries `.machine_readable/` A2ML files (`STATE.a2ml`,
23+
`META.a2ml`, `ECOSYSTEM.a2ml`, `AGENTIC.a2ml`, `NEUROSYM.a2ml`,
24+
`PLAYBOOK.a2ml`). If your change alters project state, architecture, or
25+
operational steps, update the corresponding file in the same PR — CI
26+
validates them.
27+
28+
## Language policy
29+
30+
The estate restricts which languages may be used. In particular Python, Go,
31+
TypeScript, ReScript, V-lang, Java/Kotlin, Swift and Makefiles are **not**
32+
accepted in new code; AffineScript, Rust/SPARK, Zig, Deno, Gleam, Elixir,
33+
Haskell, Idris2, Agda, Julia and OCaml are. CI enforces this, so check the
34+
policy in `hyperpolymath/standards` before introducing a new language.
35+
36+
## Documentation format
37+
38+
Docs are AsciiDoc (`.adoc`) by default, including `README.adoc`. The
39+
GitHub-required community-health files stay Markdown: `SECURITY.md`,
40+
`CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`, `CHANGELOG.md`. Do not add a `.md`
41+
duplicate of a doc that already exists as `.adoc`.
42+
43+
## Pull requests
44+
45+
1. Branch from `main` — do not push to `main` directly; branch protection
46+
requires review and passing checks.
47+
2. Keep the change focused, and explain *why* in the PR body.
48+
3. Make sure governance CI is green. It checks documentation presence,
49+
packaging policy, secrets, licence consistency and workflow security.
50+
4. Security issues: follow `SECURITY.md` — report privately, never in a
51+
public issue.

0 commit comments

Comments
 (0)