docs(contributing): add CONTRIBUTING.adoc to satisfy the armed docs gate - #16
Conversation
The Governance workflow's 'Check documentation' step (standards scripts/check-docs-presence.sh) promoted CONTRIBUTING from warning to blocking on 2026-08-21; this repo has never carried one, so 'Code quality + docs' has been red on the default branch. Adds a root CONTRIBUTING.adoc in the estate's default format (AsciiDoc), at the location GitHub auto-discovers. Content mirrors GOVERNANCE.adoc (licensing, review rules) and records, at source, why the Guix packaging policy is not applicable to a build-less curated list: the policy applies only to repos declaring reproducible-build or container (standards#1120, owner ruling 2026-10-01). Addresses #15. Co-authored-by: arena-agent <297053741+arena-agent@users.noreply.github.com>
|
Navigate logical layers of code changes, visualize relationships, and explore their blast radius. No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configuration
📒 Files selected for processing (1)
Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review. 📜 Recent review details⏰ Context from checks skipped due to timeout. (6)
🔇 Additional comments (1)
📝 SummarySummary by CodeRabbit
WalkthroughThe pull request adds contribution guidance for Haskell resources, README entries, branches and pull requests, CI checks, packaging policy, governance, and licensing. ChangesContribution guidance
Priority: ⬇️ Low Estimated code review effort: 2 (Simple) | ~10 minutes Change: Other Merge Risk: ⚪ Minimal · up to The contribution guide is mergeable on the available evidence; no actionable inconsistency has been established. Architecture SummaryArchitecture risk: 🔵 Low · up to The change affects 1 system. Changed systems: Architecture concerns Review detailsSystems and components
Before / after behavior
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. A rabbit reads the guide with care Comment |
The Governance workflow's 'Check documentation' step (standards scripts/check-docs-presence.sh) promoted CONTRIBUTING from warning to blocking on 2026-08-21; this repo has never carried one, so 'Code quality + docs' has been red on the default branch. Adds a root CONTRIBUTING.adoc in the estate's default format (AsciiDoc), at the location GitHub auto-discovers. Content mirrors GOVERNANCE.adoc (licensing, review rules) and records, at source, why the Guix packaging policy is not applicable to a build-less curated list: the policy applies only to repos declaring reproducible-build or container (standards#1120, owner ruling 2026-10-01). Addresses #15. Commit created via GraphQL createCommitOnBranch (GitHub-signed, signature valid: true).
Issue
Closes the downstream half of #15 (2 red checks on the default branch, deferred from #14).
Diagnosis (both checks, at source)
Governance / governance / Code quality + docs—Check documentationfails withMissing required documentation: CONTRIBUTING. The gate (hyperpolymath/standardsscripts/check-docs-presence.sh) split README/LICENSE (blocking immediately) from CONTRIBUTING (warn until 2026-08-21, then blocking). The cutoff has passed; this repo never carried a CONTRIBUTING, so the red is genuine and this PR is the whole fix.Governance / governance / Guix packaging policy (Nix retired)—Package policy violation: no packaging found.The old script demanded packaging of every repo. The owner ruling of 2026-10-01 (landed upstream as fix(gates): pin what reusables fetch; gate packaging on capability standards#1120 at 22:30Z, 10 h after the red run 36863734189 timestamped 12:43Z) retires that: packaging is now gated on the repo'srsr-profiledeclaringreproducible-buildorcontainer. This repo is a build-less curated list with no profile ⇒ not applicable, deliberately neutral — satisfying acceptance criterion 2's "linked change with its reason". No fakeguix.scmstub is added; the script flags stubs as violations. The reasoning is recorded at source in the new CONTRIBUTING.Changes
CONTRIBUTING.adocat the repo root — AsciiDoc per estate doc policy, one of the paths the gate accepts and GitHub auto-discovers. Content mirrorsGOVERNANCE.adoc(licensing, review rules) andMAINTAINERS, documents the awesome-list entry conventions ofREADME.adoc, the CI contract, and the packaging-policy non-applicability rationale.actions.lock, the SHA pin ofgovernance-reusable.yml, and every other gate are untouched.Local pre-run of the exact gate scripts
check-docs-presence.sh .→✅ Core documentation present (README, LICENSE, CONTRIBUTING)(exit 0; was exit 1 before this PR)check-package-policy.sh .(in the CI's script-only shape, resolver absent) →✅ Packaging not applicable(exit 0)check-licence-consistency.sh .→ exit 0 (unchanged)check-trusted-base.sh .→ exit 0 (unchanged)\*.adoc/\*.md: clean🤖 Generated with Claude Code via Arena Agent Mode