diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 419c49a..347de05 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -2,16 +2,17 @@ SPDX-License-Identifier: CC-BY-SA-4.0 Copyright (c) Jonathan D.A. Jewell --> +``` # Clone the repository -git clone https://{{FORGE}}/{{OWNER}}/{{REPO}}.git -cd {{REPO}} +git clone https://github.com/hyperpolymath/cicd-squabbler.git +cd cicd-squabbler # Using Guix (recommended for reproducibility) guix shell -D -f guix.scm # Or using toolbox/distrobox -toolbox create {{REPO}}-dev -toolbox enter {{REPO}}-dev +toolbox create cicd-squabbler-dev +toolbox enter cicd-squabbler-dev # Install dependencies manually # Verify setup @@ -21,7 +22,7 @@ just test # Run test suite ### Repository Structure ``` -{{REPO}}/ +cicd-squabbler/ ├── src/ # Source code (Perimeter 1-2) ├── lib/ # Library code (Perimeter 1-2) ├── extensions/ # Extensions (Perimeter 2) @@ -61,7 +62,7 @@ just test # Run test suite **Before reporting**: 1. Search existing issues -2. Check if it's already fixed in `{{MAIN_BRANCH}}` +2. Check if it's already fixed in `main` 3. Determine which perimeter the bug affects **When reporting**: @@ -94,10 +95,10 @@ Use the [feature request template](.github/ISSUE_TEMPLATE/feature_request.md) an Look for issues labelled: -- [`good first issue`](https://{{FORGE}}/{{OWNER}}/{{REPO}}/labels/good%20first%20issue) — Simple Perimeter 3 tasks -- [`help wanted`](https://{{FORGE}}/{{OWNER}}/{{REPO}}/labels/help%20wanted) — Community help needed -- [`documentation`](https://{{FORGE}}/{{OWNER}}/{{REPO}}/labels/documentation) — Docs improvements -- [`perimeter-3`](https://{{FORGE}}/{{OWNER}}/{{REPO}}/labels/perimeter-3) — Community sandbox scope +- [`good first issue`](https://github.com/hyperpolymath/cicd-squabbler/labels/good%20first%20issue) — Simple Perimeter 3 tasks +- [`help wanted`](https://github.com/hyperpolymath/cicd-squabbler/labels/help%20wanted) — Community help needed +- [`documentation`](https://github.com/hyperpolymath/cicd-squabbler/labels/documentation) — Docs improvements +- [`perimeter-3`](https://github.com/hyperpolymath/cicd-squabbler/labels/perimeter-3) — Community sandbox scope --- @@ -122,3 +123,4 @@ We follow [Conventional Commits](https://www.conventionalcommits.org/): [optional body] [optional footer] +``` diff --git a/.machine_readable/root-allow.txt b/.machine_readable/root-allow.txt index 20776de..edef4f3 100644 --- a/.machine_readable/root-allow.txt +++ b/.machine_readable/root-allow.txt @@ -46,6 +46,7 @@ sonar-project.properties # SonarCloud analysis config; the SonarQube scan acti .devcontainer/ # VS Code dev container spec; tool-required at root .git/ .github/ # CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md, workflows/ +www/ # site-operations bundle; canonical .well-known/ lives at www/.well-known/ (issue #53) .machine_readable/ # AI manifests, contractiles, custom-format configs .well-known/ build/ # contractile.just, setup.sh, guix.scm, .guix-channel, Containerfile