Skip to content

fix(ci,docs): repair root-shape drift and the CONTRIBUTING code fences #86

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hyperpolymath merged 3 commits into from
Sep 18, 2026
Merged

fix(ci,docs): repair root-shape drift and the CONTRIBUTING code fences #86

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cf0b65a
docs(contributing): repair unbalanced code fences
hyperpolymath Sep 18, 2026
da44fa2
docs(contributing): materialise the template placeholders
hyperpolymath Sep 18, 2026
450adfa
chore(root): allowlist the www/ site bundle
hyperpolymath Sep 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 12 additions & 10 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,17 @@
SPDX-License-Identifier: CC-BY-SA-4.0
Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
-->
```
# 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
Expand All @@ -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)
Expand Down Expand Up @@ -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**:
Expand Down Expand Up @@ -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

---

Expand All @@ -122,3 +123,4 @@ We follow [Conventional Commits](https://www.conventionalcommits.org/):
[optional body]

[optional footer]
```
1 change: 1 addition & 0 deletions .machine_readable/root-allow.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading