Skip to content

Commit 2d6cc12

Browse files
fix(docs): repair the contributing guide content defects (#97)
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.
1 parent b441a01 commit 2d6cc12

1 file changed

Lines changed: 32 additions & 29 deletions

File tree

‎.github/CONTRIBUTING.md‎

Lines changed: 32 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,40 @@
11
# Clone the repository
22

3-
git clone <https://github.com/hyperpolymath/nextgen-databases.git> cd
4-
nextgen-databases
3+
git clone https://github.com/hyperpolymath/nextgen-databases.git
4+
cd nextgen-databases
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 nextgen-databases-dev toolbox enter nextgen-databases-dev
13-
\# Install dependencies manually
12+
toolbox create nextgen-databases-dev
13+
toolbox enter nextgen-databases-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

20-
21-
### Repository Structure
21+
### Repository Structure
2222

2323
`nextgen-databases` is a **coordination repo** — it does not hold database
2424
implementations. Each database and query language has its own repo (see `REGISTRY.adoc`).
2525

2626
nextgen-databases/ ├── README.adoc / EXPLAINME.adoc / TOPOLOGY.adoc /
27-
ROADMAP.adoc \# Portfolio docs ├── REGISTRY.adoc \# Authoritative map:
27+
ROADMAP.adoc # Portfolio docs ├── REGISTRY.adoc # Authoritative map:
2828
database/language → its own repo ├── CLAUDE.md / AGENTS.md /
29-
0-AI-MANIFEST.a2ml \# Agent guardrails ├── docs/ \# Coordination docs
30-
(incl. migration runbooks) ├── tests/ \# CROSS-database integration
31-
tests only ├── .machine_readable/ \# Canonical SCM metadata ├── .github/
32-
\# CI/CD, issue templates, governance ├── .well-known/ LICENSES/ └──
33-
flake.nix / Justfile / stapeln.toml / opsm.toml \# Shared env &
29+
0-AI-MANIFEST.a2ml # Agent guardrails ├── docs/ # Coordination docs
30+
(incl. migration runbooks) ├── tests/ # CROSS-database integration
31+
tests only ├── .machine_readable/ # Canonical SCM metadata ├── .github/
32+
# CI/CD, issue templates, governance ├── .well-known/ LICENSES/ └──
33+
flake.nix / Justfile / stapeln.toml / opsm.toml # Shared env &
3434
orchestration
3535

3636

37-
#### What belongs here vs. in a database repo
37+
#### What belongs here vs. in a database repo
3838

3939
- ✅ **Here**: portfolio docs, the registry, cross-database integration tests, shared
4040
infrastructure/orchestration, governance and machine-readable metadata.
@@ -47,9 +47,9 @@ orchestration
4747

4848
---
4949

50-
## How to Contribute
50+
## How to Contribute
5151

52-
### Reporting Bugs
52+
### Reporting Bugs
5353

5454
**Before reporting**:
5555
1. Search existing issues
@@ -66,7 +66,7 @@ orchestration
6666
- Expected vs actual behaviour
6767
- Logs, screenshots, or minimal reproduction
6868

69-
### Suggesting Features
69+
### Suggesting Features
7070

7171
**Before suggesting**:
7272
1. Check the [roadmap](ROADMAP.md) if available
@@ -82,7 +82,7 @@ orchestration
8282
- Alternatives considered
8383
- Which perimeter this affects
8484

85-
### Your First Contribution
85+
### Your First Contribution
8686

8787
Look for issues labelled:
8888

@@ -93,22 +93,25 @@ orchestration
9393

9494
---
9595

96-
## Development Workflow
96+
## Development Workflow
9797

98-
### Branch Naming
98+
### Branch Naming
9999

100-
docs/short-description \# Documentation (P3) test/what-added \# Test
101-
additions (P3) feat/short-description \# New features (P2)
102-
fix/issue-number-description \# Bug fixes (P2) refactor/what-changed \#
103-
Code improvements (P2) security/what-fixed \# Security fixes (P1-2)
100+
docs/short-description # Documentation (P3) test/what-added # Test
101+
additions (P3) feat/short-description # New features (P2)
102+
fix/issue-number-description # Bug fixes (P2) refactor/what-changed #
103+
Code improvements (P2) security/what-fixed # Security fixes (P1-2)
104104

105105

106-
### Commit Messages
106+
### Commit Messages
107107

108108
We follow [Conventional Commits](https://www.conventionalcommits.org/):
109109

110-
():
110+
type(scope): description
111+
112+
Body: what changed and why.
111113

114+
Footer: issue reference, e.g. Closes #123
112115
\[optional body\]
113116

114117
\[optional footer\]

0 commit comments

Comments
 (0)