Skip to content

Commit ba9ecbc

Browse files
fix(docs): list the contributing guide where it actually lives (#83)
The "Repository Structure" block still listed `CONTRIBUTING.md` at the repository root, but the guide lives at `.github/CONTRIBUTING.md` — the entry pointed at a location it had already moved away from. This is the only change: the entry moves under the tree's existing `.github/` branch, at the block's own comment column. The tree already rendered correctly and its layout is untouched. Placeholder tokens in the block resolve to real values. --- The contributing guide was instantiated from the estate template and kept one of the template's tokens verbatim: `{{MAIN_BRANCH}}`, in > 2. Check if it's already fixed in `{{MAIN_BRANCH}}` The token is correct in the template itself, but a reader of this repository sees it literally. It resolves to this repository's default branch. One token — nothing else in the guide changes.
1 parent a70dfb4 commit ba9ecbc

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

‎.github/CONTRIBUTING.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Clone the repository
2-
git clone https://{{FORGE}}/{{OWNER}}/{{REPO}}.git
3-
cd {{REPO}}
2+
git clone https://github.com/hyperpolymath/methodologies.git
3+
cd methodologies
44

55
# Using Nix (recommended for reproducibility)
66
nix develop
77

88
# Or using toolbox/distrobox
9-
toolbox create {{REPO}}-dev
10-
toolbox enter {{REPO}}-dev
9+
toolbox create methodologies-dev
10+
toolbox enter methodologies-dev
1111
# Install dependencies manually
1212

1313
# Verify setup
@@ -17,7 +17,7 @@ just test # Run test suite
1717
1818
### Repository Structure
1919
```
20-
{{REPO}}/
20+
methodologies/
2121
├── src/ # Source code (Perimeter 1-2)
2222
├── lib/ # Library code (Perimeter 1-2)
2323
├── extensions/ # Extensions (Perimeter 2)
@@ -35,11 +35,11 @@ just test # Run test suite
3535
│ └── contractiles/ # Policy contracts (k9, dust, lust, must, trust)
3636
├── .well-known/ # Protocol files (Perimeter 1-3)
3737
├── .github/ # GitHub config (Perimeter 1)
38+
│ ├── CONTRIBUTING.md # This file
3839
│ ├── ISSUE_TEMPLATE/
3940
│ └── workflows/
4041
├── CHANGELOG.md
4142
├── CODE_OF_CONDUCT.md
42-
├── CONTRIBUTING.md # This file
4343
├── GOVERNANCE.md
4444
├── LICENSE
4545
├── MAINTAINERS.md
@@ -58,7 +58,7 @@ just test # Run test suite
5858
5959
**Before reporting**:
6060
1. Search existing issues
61-
2. Check if it's already fixed in `{{MAIN_BRANCH}}`
61+
2. Check if it's already fixed in `main`
6262
3. Determine which perimeter the bug affects
6363
6464
**When reporting**:
@@ -91,10 +91,10 @@ Use the [feature request template](.github/ISSUE_TEMPLATE/feature_request.md) an
9191
9292
Look for issues labelled:
9393
94-
- [`good first issue`](https://{{FORGE}}/{{OWNER}}/{{REPO}}/labels/good%20first%20issue) — Simple Perimeter 3 tasks
95-
- [`help wanted`](https://{{FORGE}}/{{OWNER}}/{{REPO}}/labels/help%20wanted) — Community help needed
96-
- [`documentation`](https://{{FORGE}}/{{OWNER}}/{{REPO}}/labels/documentation) — Docs improvements
97-
- [`perimeter-3`](https://{{FORGE}}/{{OWNER}}/{{REPO}}/labels/perimeter-3) — Community sandbox scope
94+
- [`good first issue`](https://github.com/hyperpolymath/methodologies/labels/good%20first%20issue) — Simple Perimeter 3 tasks
95+
- [`help wanted`](https://github.com/hyperpolymath/methodologies/labels/help%20wanted) — Community help needed
96+
- [`documentation`](https://github.com/hyperpolymath/methodologies/labels/documentation) — Docs improvements
97+
- [`perimeter-3`](https://github.com/hyperpolymath/methodologies/labels/perimeter-3) — Community sandbox scope
9898
9999
---
100100

0 commit comments

Comments
 (0)