Skip to content

Commit 6ef5fce

Browse files
fix(docs): repair the contributing guide content defects (#61)
Mechanical repairs to `.github/CONTRIBUTING.md`, each anchored on a specific 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 **Why these:** they are the classes reviewers keep flagging on this file — template tokens left unsubstituted, commands collapsed onto one line by the AsciiDoc→Markdown conversion so copying them passes extra arguments, `\#` escapes where `#` was meant, an invalid `():` commit header, and a four-space indent that made headings render as code. No prose is rewritten; only the broken forms are corrected. If a pattern is not present the file is untouched. --------- Signed-off-by: Jonathan D.A. Jewell <6759885+hyperpolymath@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
1 parent 0b8a7f8 commit 6ef5fce

1 file changed

Lines changed: 53 additions & 35 deletions

File tree

‎.github/CONTRIBUTING.md‎

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

3-
git clone <https://github.com/hyperpolymath/nextgen-languages.git> cd
4-
nextgen-languages
3+
git clone https://github.com/hyperpolymath/nextgen-languages.git
4+
cd error-lang
55

66
# Using Guix (recommended for reproducibility)
77

88
guix develop
99

1010
# Or using toolbox/distrobox
1111

12-
toolbox create nextgen-languages-dev toolbox enter nextgen-languages-dev
13-
\# Install dependencies manually
12+
toolbox create nextgen-languages-dev
13+
toolbox enter nextgen-languages-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
19-
20-
21-
### Repository Structure
22-
23-
nextgen-languages/ ├── 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) │ ├──
31-
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.guix \# Guix
34-
flake (Perimeter 1) └── Justfile \# Task runner (Perimeter 1)
35-
18+
just doctor # Check environment
19+
just test # Run test suite
20+
21+
### Repository Structure
22+
23+
```text
24+
error-lang/
25+
├── src/ # Source code (Perimeter 1-2)
26+
├── lib/ # Library code (Perimeter 1-2)
27+
├── extensions/ # Extensions (Perimeter 2)
28+
├── plugins/ # Plugins (Perimeter 2)
29+
├── tools/ # Tooling (Perimeter 2)
30+
├── docs/ # Documentation (Perimeter 3)
31+
│ ├── architecture/ # ADRs, specs (Perimeter 2)
32+
│ └── proposals/ # RFCs (Perimeter 3)
33+
├── examples/ # Examples (Perimeter 3)
34+
├── spec/ # Spec tests (Perimeter 3)
35+
├── tests/ # Test suite (Perimeter 2-3)
36+
├── .well-known/ # Protocol files (Perimeter 1-3)
37+
├── .github/ # GitHub config (Perimeter 1)
38+
│ ├── CONTRIBUTING.md # This file
39+
│ ├── ISSUE_TEMPLATE/
40+
│ └── workflows/
41+
├── CHANGELOG.md
42+
├── CODE_OF_CONDUCT.md
43+
├── GOVERNANCE.md
44+
├── LICENSE
45+
├── MAINTAINERS.md
46+
├── README.adoc
47+
├── SECURITY.md
48+
├── flake.guix # Guix flake (Perimeter 1)
49+
└── Justfile # Task runner (Perimeter 1)
50+
```
3651

3752
---
3853

39-
## How to Contribute
54+
## How to Contribute
4055

41-
### Reporting Bugs
56+
### Reporting Bugs
4257

4358
**Before reporting**:
4459
1. Search existing issues
@@ -55,7 +70,7 @@ flake (Perimeter 1) └── Justfile \# Task runner (Perimeter 1)
5570
- Expected vs actual behaviour
5671
- Logs, screenshots, or minimal reproduction
5772

58-
### Suggesting Features
73+
### Suggesting Features
5974

6075
**Before suggesting**:
6176
1. Check the [roadmap](ROADMAP.md) if available
@@ -71,7 +86,7 @@ flake (Perimeter 1) └── Justfile \# Task runner (Perimeter 1)
7186
- Alternatives considered
7287
- Which perimeter this affects
7388

74-
### Your First Contribution
89+
### Your First Contribution
7590

7691
Look for issues labelled:
7792

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

8398
---
8499

85-
## Development Workflow
100+
## Development Workflow
86101

87-
### Branch Naming
102+
### Branch Naming
88103

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)
104+
docs/short-description # Documentation (P3) test/what-added # Test
105+
additions (P3) feat/short-description # New features (P2)
106+
fix/issue-number-description # Bug fixes (P2) refactor/what-changed #
107+
Code improvements (P2) security/what-fixed # Security fixes (P1-2)
93108

94109

95-
### Commit Messages
110+
### Commit Messages
96111

97112
We follow [Conventional Commits](https://www.conventionalcommits.org/):
98113

99-
():
114+
type(scope): description
115+
116+
Body: what changed and why.
100117

118+
Footer: issue reference, e.g. Closes #123
101119
\[optional body\]
102120

103121
\[optional footer\]

0 commit comments

Comments
 (0)