From b7b0a92668b5311a23b20211a386629711267c9a Mon Sep 17 00:00:00 2001 From: "Jonathan D.A. Jewell" <6759885+hyperpolymath@users.noreply.github.com> Date: Sat, 19 Sep 2026 09:35:06 +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) * .hypatia/scan-cache/fix-http-to-https.hashes * CONTRIBUTING.adoc (deleted) * PROVEN-COMPREHENSIVE-ANALYSIS-2026-01-30.adoc * README.adoc --- .github/CONTRIBUTING.md | 71 +++++++++++++++++++ .hypatia/scan-cache/fix-http-to-https.hashes | 2 +- CONTRIBUTING.adoc | 71 ------------------- PROVEN-COMPREHENSIVE-ANALYSIS-2026-01-30.adoc | 6 +- README.adoc | 2 +- 5 files changed, 76 insertions(+), 76 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 00000000..20bc8378 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,71 @@ +# Contributing + +Thank you for your interest in contributing! We follow a “Dual-Track” +architecture where human-readable documentation lives in the root and +machine-readable policies live in `.machine_readable/`. + +## How to Contribute + +We welcome contributions in many forms: + +- **Code:** Improving the core stack or extensions + +- **Documentation:** Enhancing docs or AI manifests + +- **Testing:** Adding property-based tests or formal proofs + +- **Bug reports:** Filing clear, reproducible issues + +## Getting Started + +1. **Read the AI Manifest:** Start with `0-AI-MANIFEST.a2ml` (if + present) to understand the repository structure. + +2. **Environment:** Use `nix` `develop` or `direnv` `allow` to set up + your tools. + +3. **Task Runner:** Use `just` to see available commands (`just` + `--list`). + +## Development Workflow + +### Branch Naming + + 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 [Conventional Commits](https://www.conventionalcommits.org/): + + (): + + [optional body] + + [optional footer] + +Types: `feat`, `fix`, `docs`, `test`, `refactor`, `ci`, `chore`, +`security` + +## Reporting Bugs + +Before reporting: 1. Search existing issues 2. Check if it’s already +fixed in `main` + +When reporting, include: - Clear, descriptive title - Environment +details (OS, versions, toolchain) - Steps to reproduce - Expected vs +actual behaviour + +## Code of Conduct + +All contributors are expected to adhere to our [Code of +Conduct](CODE_OF_CONDUCT.md). + +## License + +By contributing, you agree that your contributions will be licensed +under the same license as the project (see LICENSE). diff --git a/.hypatia/scan-cache/fix-http-to-https.hashes b/.hypatia/scan-cache/fix-http-to-https.hashes index b66336df..90757843 100644 --- a/.hypatia/scan-cache/fix-http-to-https.hashes +++ b/.hypatia/scan-cache/fix-http-to-https.hashes @@ -223,7 +223,7 @@ b68fc56ff40000ce91d66e90dfc01dc3cd15778c6226da8654d96c6c133ebf60 bindings/elixi fa340020278b3ae2d475ef9d3bcfd2081d74050f95cb43b6eb4b8aeef894c10d bindings/purescript/Proven/SafeFloat.js 759d0c5c0e76bd0deddeecb69a78f41bc8990fbc57ede0553b47c62025a1b9c4 bindings/rust/src/safe_datetime.rs d11b5f805e9dc9c7d61381d639e53d472db2cac486866cd7ac6833b83451e65e bindings/mustache/helpers/proven-helpers.js -e0ea092234708d29ab1c3f7285dab3465bc035fa0705f555204df64305bace2e CONTRIBUTING.adoc +e0ea092234708d29ab1c3f7285dab3465bc035fa0705f555204df64305bace2e ../../.github/CONTRIBUTING.md fd2f75e68af5c4c17657a967447d90514d1721df5c505088efc5d4ad2b89d506 .devcontainer/post-create.sh f2c61c0849b329ea48f75577f1b1016f1dd62a7a5cca55a2f29c6cc64cab4517 .github/workflows/publish-ghcr.yml 1016d843b02e77760b1ffe6af8bbb6bf069347f56a23f766935474323acbdac2 bindings/elixir/lib/proven/safe_version.ex diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc deleted file mode 100644 index 858f44fd..00000000 --- a/CONTRIBUTING.adoc +++ /dev/null @@ -1,71 +0,0 @@ -== Contributing - -Thank you for your interest in contributing! We follow a "`Dual-Track`" -architecture where human-readable documentation lives in the root and -machine-readable policies live in `+.machine_readable/+`. - -=== How to Contribute - -We welcome contributions in many forms: - -* *Code:* Improving the core stack or extensions -* *Documentation:* Enhancing docs or AI manifests -* *Testing:* Adding property-based tests or formal proofs -* *Bug reports:* Filing clear, reproducible issues - -=== Getting Started - -[arabic] -. *Read the AI Manifest:* Start with `+0-AI-MANIFEST.a2ml+` (if present) -to understand the repository structure. -. *Environment:* Use `+nix develop+` or `+direnv allow+` to set up your -tools. -. *Task Runner:* Use `+just+` to see available commands -(`+just --list+`). - -=== Development Workflow - -==== Branch Naming - -.... -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]: - -.... -(): - -[optional body] - -[optional footer] -.... - -Types: `+feat+`, `+fix+`, `+docs+`, `+test+`, `+refactor+`, `+ci+`, -`+chore+`, `+security+` - -=== Reporting Bugs - -Before reporting: 1. Search existing issues 2. Check if it’s already -fixed in `+main+` - -When reporting, include: - Clear, descriptive title - Environment -details (OS, versions, toolchain) - Steps to reproduce - Expected vs -actual behaviour - -=== Code of Conduct - -All contributors are expected to adhere to our -link:CODE_OF_CONDUCT.md[Code of Conduct]. - -=== License - -By contributing, you agree that your contributions will be licensed -under the same license as the project (see LICENSE). diff --git a/PROVEN-COMPREHENSIVE-ANALYSIS-2026-01-30.adoc b/PROVEN-COMPREHENSIVE-ANALYSIS-2026-01-30.adoc index 0103163e..12c5ee64 100644 --- a/PROVEN-COMPREHENSIVE-ANALYSIS-2026-01-30.adoc +++ b/PROVEN-COMPREHENSIVE-ANALYSIS-2026-01-30.adoc @@ -165,7 +165,7 @@ Testing: * *Test Files:* 29 property tests + 20 unit tests ✓ * *Fuzzing:* ClusterFuzzLite integration ✓ * *CI/CD:* GitHub Actions workflows ✓ -* *Documentation:* README.adoc ✓, CONTRIBUTING.adoc ✓, SECURITY.md ✓ +* *Documentation:* README.adoc ✓, .github/CONTRIBUTING.md ✓, SECURITY.md ✓ ==== Language Bindings (89 targets) @@ -422,7 +422,7 @@ BSD) * META.scm (ADRs, design rationale) * ECOSYSTEM.scm (project relationships) * README.adoc (excellent, detailed) -* CONTRIBUTING.adoc ✓ +* .github/CONTRIBUTING.md ✓ * CODE_OF_CONDUCT.md ✓ * SECURITY.md ✓ * CHANGELOG.md ✓ @@ -514,7 +514,7 @@ Based on Rhodium Standard Repositories (RSR): * [x] META.scm present with ADRs * [x] ECOSYSTEM.scm present * [x] README.adoc comprehensive -* [x] CONTRIBUTING.adoc +* [x] .github/CONTRIBUTING.md * [x] CODE_OF_CONDUCT.md * [x] SECURITY.md * [x] LICENSE files (MPL-2.0-or-later) diff --git a/README.adoc b/README.adoc index 38acbab8..c71d4c5f 100644 --- a/README.adoc +++ b/README.adoc @@ -1947,7 +1947,7 @@ Crashes are a choice. Choose otherwise. == Contributing -We welcome contributions! See link:CONTRIBUTING.adoc[CONTRIBUTING.adoc]. +We welcome contributions! See link:.github/CONTRIBUTING.md[.github/CONTRIBUTING.md]. Especially needed: * Language binding maintainers (Scala, F#, Crystal, etc.)