From fb998b0eaa2d35e7950a287f13f230ed312993a2 Mon Sep 17 00:00:00 2001 From: "Jonathan D.A. Jewell" <6759885+hyperpolymath@users.noreply.github.com> Date: Sat, 19 Sep 2026 09:09:18 +0000 Subject: [PATCH] refactor(root): relocate the contributing guide into .github/ The estate canonical location is .github/CONTRIBUTING.md, which GitHub auto-discovers; the root copy is removed and references are updated in the same change. * .github/CONTRIBUTING.md (new) * CONTRIBUTING.adoc (deleted) * MAINTAINERS.adoc --- .github/CONTRIBUTING.md | 68 +++++++++++++++++++++++++++++++++++++++++ CONTRIBUTING.adoc | 66 --------------------------------------- MAINTAINERS.adoc | 2 +- 3 files changed, 69 insertions(+), 67 deletions(-) create mode 100644 .github/CONTRIBUTING.md delete mode 100644 CONTRIBUTING.adoc diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..1225578 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,68 @@ +# Contributing to bag-of-actions + +Thanks for your interest. This repository follows the Hyperpolymath +estate standards defined in +[hyperpolymath/standards](https://github.com/hyperpolymath/standards). + +## Licence + +This project is licensed under **MPL-2.0**. By contributing you agree +that your contributions are licensed under the same terms. Every source +file carries an `SPDX-License-Identifier` header; keep it when editing, +and add one to any new file. + +## Development environment + +Use the toolchain declared by this repository (just zig). + +## Build and test + +This repo uses [`just`](https://just.systems) (the estate uses +Justfiles, never Makefiles). Recipes available here: + +``` sh +just # list recipes +just fmt # format +just fmt-check # check formatting +just lint # lint +just test-all # run the full suite +just doctor # environment diagnostics +``` + +## Machine-readable artefacts + +This repo carries `.machine_readable/` A2ML files (`STATE.a2ml`, +`META.a2ml`, `ECOSYSTEM.a2ml`, `AGENTIC.a2ml`, `NEUROSYM.a2ml`, +`PLAYBOOK.a2ml`). If your change alters project state, architecture, or +operational steps, update the corresponding file in the same PR — CI +validates them. + +## Language policy + +The estate restricts which languages may be used. In particular Python, +Go, TypeScript, AffineScript, V-lang, Java/Kotlin, Swift and Makefiles +are **not** accepted in new code; AffineScript, Rust/SPARK, Zig, Deno, +Gleam, Elixir, Haskell, Idris2, Agda, Julia and OCaml are. CI enforces +this, so check the policy in `hyperpolymath/standards` before +introducing a new language. + +## Documentation format + +Docs are AsciiDoc (`.adoc`) by default, including `README.adoc`. The +GitHub-required community-health files stay Markdown: `SECURITY.md`, +`CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`, `CHANGELOG.md`. Do not add a +`.md` duplicate of a doc that already exists as `.adoc`. + +## Pull requests + +1. Branch from `main` — do not push to `main` directly; branch + protection requires review and passing checks. + +2. Keep the change focused, and explain *why* in the PR body. + +3. Make sure governance CI is green. It checks documentation presence, + packaging policy, secrets, licence consistency and workflow + security. + +4. Security issues: follow `SECURITY.md` — report privately, never in a + public issue. diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc deleted file mode 100644 index 8a28f1a..0000000 --- a/CONTRIBUTING.adoc +++ /dev/null @@ -1,66 +0,0 @@ -== Contributing to bag-of-actions - -Thanks for your interest. This repository follows the Hyperpolymath -estate standards defined in -https://github.com/hyperpolymath/standards[hyperpolymath/standards]. - -=== Licence - -This project is licensed under *MPL-2.0*. By contributing you agree that -your contributions are licensed under the same terms. Every source file -carries an `+SPDX-License-Identifier+` header; keep it when editing, and -add one to any new file. - -=== Development environment - -Use the toolchain declared by this repository (just zig). - -=== Build and test - -This repo uses https://just.systems[`+just+`] (the estate uses -Justfiles, never Makefiles). Recipes available here: - -[source,sh] ----- -just # list recipes -just fmt # format -just fmt-check # check formatting -just lint # lint -just test-all # run the full suite -just doctor # environment diagnostics ----- - -=== Machine-readable artefacts - -This repo carries `+.machine_readable/+` A2ML files (`+STATE.a2ml+`, -`+META.a2ml+`, `+ECOSYSTEM.a2ml+`, `+AGENTIC.a2ml+`, `+NEUROSYM.a2ml+`, -`+PLAYBOOK.a2ml+`). If your change alters project state, architecture, -or operational steps, update the corresponding file in the same PR — CI -validates them. - -=== Language policy - -The estate restricts which languages may be used. In particular Python, -Go, TypeScript, AffineScript, V-lang, Java/Kotlin, Swift and Makefiles -are *not* accepted in new code; AffineScript, Rust/SPARK, Zig, Deno, -Gleam, Elixir, Haskell, Idris2, Agda, Julia and OCaml are. CI enforces -this, so check the policy in `+hyperpolymath/standards+` before -introducing a new language. - -=== Documentation format - -Docs are AsciiDoc (`+.adoc+`) by default, including `+README.adoc+`. The -GitHub-required community-health files stay Markdown: `+SECURITY.md+`, -`+CONTRIBUTING.md+`, `+CODE_OF_CONDUCT.md+`, `+CHANGELOG.md+`. Do not -add a `+.md+` duplicate of a doc that already exists as `+.adoc+`. - -=== Pull requests - -[arabic] -. Branch from `+main+` — do not push to `+main+` directly; branch -protection requires review and passing checks. -. Keep the change focused, and explain _why_ in the PR body. -. Make sure governance CI is green. It checks documentation presence, -packaging policy, secrets, licence consistency and workflow security. -. Security issues: follow `+SECURITY.md+` — report privately, never in a -public issue. diff --git a/MAINTAINERS.adoc b/MAINTAINERS.adoc index daf8a78..97edfcd 100644 --- a/MAINTAINERS.adoc +++ b/MAINTAINERS.adoc @@ -62,4 +62,4 @@ For questions about project governance: * link:GOVERNANCE.adoc[Governance Model] * link:CODE_OF_CONDUCT.md[Code of Conduct] -* link:CONTRIBUTING.adoc[Contributing Guide] +* link:.github/CONTRIBUTING.md[Contributing Guide]