Skip to content

Commit fa91931

Browse files
committed
fix(docs): repair the contributing guide content defects
Mechanical repairs to the guide, each anchored on a known-broken form: - unescaped \# -> # - rebuilt the hard-wrapped setup block into one command per line - replaced invalid `():` commit header - dedented headings that rendered as code No prose is rewritten; only the broken forms are corrected.
1 parent 2db935d commit fa91931

1 file changed

Lines changed: 36 additions & 33 deletions

File tree

‎.github/CONTRIBUTING.md‎

Lines changed: 36 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,44 @@
11
# Clone the repository
22

3-
git clone <https://github.com/hyperpolymath/developer-ecosystem.git> cd
4-
developer-ecosystem
3+
git clone https://github.com/hyperpolymath/developer-ecosystem.git
4+
cd developer-ecosystem
55

6-
# Using Nix (recommended for reproducibility)
6+
# Using Guix (recommended for reproducibility)
77

8-
nix develop
8+
guix develop
99

1010
# Or using toolbox/distrobox
1111

12-
toolbox create developer-ecosystem-dev toolbox enter
13-
developer-ecosystem-dev \# Install dependencies manually
12+
toolbox create developer-ecosystem-dev
13+
toolbox enter developer-ecosystem-dev
14+
# Install dependencies manually
1415

1516
# Verify setup
1617

17-
just check \# or: cargo check / mix compile / etc. just test \# Run test
18-
suite
18+
just check # or: cargo check / mix compile / etc.
19+
just test # Run test suite
1920

21+
### Repository Structure
2022

21-
### Repository Structure
22-
23-
developer-ecosystem/ ├── src/ \# Source code (Perimeter 1-2) ├── lib/ \#
24-
Library code (Perimeter 1-2) ├── extensions/ \# Extensions (Perimeter 2)
25-
├── plugins/ \# Plugins (Perimeter 2) ├── tools/ \# Tooling (Perimeter
26-
2) ├── docs/ \# Documentation (Perimeter 3) │ ├── architecture/ \# ADRs,
27-
specs (Perimeter 2) │ └── proposals/ \# RFCs (Perimeter 3) ├── examples/
28-
\# Examples (Perimeter 3) ├── spec/ \# Spec tests (Perimeter 3) ├──
29-
tests/ \# Test suite (Perimeter 2-3) ├── .well-known/ \# Protocol files
30-
(Perimeter 1-3) ├── .github/ \# GitHub config (Perimeter 1) │ ├──
23+
developer-ecosystem/ ├── src/ # Source code (Perimeter 1-2) ├── lib/ #
24+
Library code (Perimeter 1-2) ├── extensions/ # Extensions (Perimeter 2)
25+
├── plugins/ # Plugins (Perimeter 2) ├── tools/ # Tooling (Perimeter
26+
2) ├── docs/ # Documentation (Perimeter 3) │ ├── architecture/ # ADRs,
27+
specs (Perimeter 2) │ └── proposals/ # RFCs (Perimeter 3) ├── examples/
28+
# Examples (Perimeter 3) ├── spec/ # Spec tests (Perimeter 3) ├──
29+
tests/ # Test suite (Perimeter 2-3) ├── .well-known/ # Protocol files
30+
(Perimeter 1-3) ├── .github/ # GitHub config (Perimeter 1) │ ├──
3131
ISSUE_TEMPLATE/ │ └── workflows/ ├── CHANGELOG.md ├── CODE_OF_CONDUCT.md
32-
├── CONTRIBUTING.md \# This file ├── GOVERNANCE.md ├── LICENSE ├──
33-
MAINTAINERS.md ├── README.adoc ├── SECURITY.md ├── flake.nix \# Nix
34-
flake (Perimeter 1) └── Justfile \# Task runner (Perimeter 1)
32+
├── CONTRIBUTING.md # This file ├── GOVERNANCE.md ├── LICENSE ├──
33+
MAINTAINERS.md ├── README.adoc ├── SECURITY.md ├── flake.nix # Nix
34+
flake (Perimeter 1) └── Justfile # Task runner (Perimeter 1)
3535

3636

3737
---
3838

39-
## How to Contribute
39+
## How to Contribute
4040

41-
### Reporting Bugs
41+
### Reporting Bugs
4242

4343
**Before reporting**:
4444
1. Search existing issues
@@ -55,7 +55,7 @@ flake (Perimeter 1) └── Justfile \# Task runner (Perimeter 1)
5555
- Expected vs actual behaviour
5656
- Logs, screenshots, or minimal reproduction
5757

58-
### Suggesting Features
58+
### Suggesting Features
5959

6060
**Before suggesting**:
6161
1. Check the [roadmap](ROADMAP.md) if available
@@ -71,7 +71,7 @@ flake (Perimeter 1) └── Justfile \# Task runner (Perimeter 1)
7171
- Alternatives considered
7272
- Which perimeter this affects
7373

74-
### Your First Contribution
74+
### Your First Contribution
7575

7676
Look for issues labelled:
7777

@@ -82,22 +82,25 @@ flake (Perimeter 1) └── Justfile \# Task runner (Perimeter 1)
8282

8383
---
8484

85-
## Development Workflow
85+
## Development Workflow
8686

87-
### Branch Naming
87+
### Branch Naming
8888

89-
docs/short-description \# Documentation (P3) test/what-added \# Test
90-
additions (P3) feat/short-description \# New features (P2)
91-
fix/issue-number-description \# Bug fixes (P2) refactor/what-changed \#
92-
Code improvements (P2) security/what-fixed \# Security fixes (P1-2)
89+
docs/short-description # Documentation (P3) test/what-added # Test
90+
additions (P3) feat/short-description # New features (P2)
91+
fix/issue-number-description # Bug fixes (P2) refactor/what-changed #
92+
Code improvements (P2) security/what-fixed # Security fixes (P1-2)
9393

9494

95-
### Commit Messages
95+
### Commit Messages
9696

9797
We follow [Conventional Commits](https://www.conventionalcommits.org/):
9898

99-
():
99+
type(scope): description
100+
101+
Body: what changed and why.
100102

103+
Footer: issue reference, e.g. Closes #123
101104
\[optional body\]
102105

103106
\[optional footer\]

0 commit comments

Comments
 (0)