From 1356b2a5926199f6e5749b3da37852d4ba21be4a Mon Sep 17 00:00:00 2001 From: arena-agent Date: Sun, 20 Sep 2026 02:05:02 +0000 Subject: [PATCH 1/2] =?UTF-8?q?docs:=20root=20CONTRIBUTING.adoc=20?= =?UTF-8?q?=E2=80=94=20satisfy=20the=20estate=20docs=20gate?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The estate docs gate (hyperpolymath/standards scripts/check-docs-presence.sh, run by the Governance reusable) requires CONTRIBUTING at the repository root (CONTRIBUTING.md | CONTRIBUTING.adoc | 3-practice/CONTRIBUTING.adoc); its grace cutoff 2026-08-21 has armed, so Governance's docs step fails without it. Adds a root CONTRIBUTING.adoc following the estate norm (AsciiDoc by default; 32 of 40 sampled estate repos already carry one). Content covers setup, branch naming, and Conventional Commits per estate conventions. --- CONTRIBUTING.adoc | 58 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 CONTRIBUTING.adoc diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc new file mode 100644 index 0000000..5c1b2dd --- /dev/null +++ b/CONTRIBUTING.adoc @@ -0,0 +1,58 @@ +// SPDX-License-Identifier: CC-BY-SA-4.0 +// SPDX-FileCopyrightText: Jonathan D.A. Jewell (hyperpolymath) += Contributing — Axiology.jl +:toc: left + +Contributions to `Axiology.jl` follow the Hyperpolymath estate conventions: +AsciiDoc for documentation, Conventional Commits, and real (not mocked) +integration tests where the estate policy applies. + +== Local-dev setup + +This repository ships a `Justfile`; `just` lists the available recipes. + +[source,bash] +---- +git clone git@github.com:hyperpolymath/Axiology.jl.git +cd Axiology.jl +just # lists the available recipes +---- + +== Reporting bugs and suggesting features + +* Search existing issues first; check whether `main` already fixes the problem. +* Use the issue templates where present; include environment details, + steps to reproduce, and expected vs actual behaviour. + +== Branch naming + +[source,text] +---- +docs/short-description # Documentation +test/what-added # Test additions +feat/short-description # New features +fix/issue-number-description # Bug fixes +refactor/what-changed # Code improvements +security/what-fixed # Security fixes +---- + +== Commit messages + +We follow https://www.conventionalcommits.org/[Conventional Commits]: + +[source,text] +---- +(): + +[optional body] + +[optional footer] +---- + +== Cross-references + +This root document exists because the estate docs gate +(`hyperpolymath/standards` `scripts/check-docs-presence.sh`) requires +`CONTRIBUTING.md`, `CONTRIBUTING.adoc`, or `3-practice/CONTRIBUTING.adoc` +at the repository root. Estate documentation policy: AsciiDoc by default — +see `hyperpolymath/standards`. From c285c0c1a24b2343529a82f235ae0a7b36bc34f3 Mon Sep 17 00:00:00 2001 From: "Jonathan D.A. Jewell" <6759885+hyperpolymath@users.noreply.github.com> Date: Sun, 20 Sep 2026 03:09:39 +0100 Subject: [PATCH 2/2] Update CONTRIBUTING.adoc Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Signed-off-by: Jonathan D.A. Jewell <6759885+hyperpolymath@users.noreply.github.com> --- CONTRIBUTING.adoc | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index 5c1b2dd..ea33a06 100644 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc @@ -13,7 +13,9 @@ This repository ships a `Justfile`; `just` lists the available recipes. [source,bash] ---- -git clone git@github.com:hyperpolymath/Axiology.jl.git +git clone https://github.com/hyperpolymath/Axiology.jl.git +# Or, with a configured GitHub SSH key: +# git clone git@github.com:hyperpolymath/Axiology.jl.git cd Axiology.jl just # lists the available recipes ----