Skip to content

Commit badb2c8

Browse files
refactor(root): relocate the contributing guide into .github/ (#155)
refactor(root): relocate the contributing guide into .github/ The estate canonical location is .github/CONTRIBUTING.md, which GitHub auto-discovers; the root copy is removed and references are updated in the same change. * .github/CONTRIBUTING.md (new) * 0-AI-MANIFEST.a2ml * CONTRIBUTING.adoc (deleted) * MAINTAINERS.adoc * docs/wiki/Contributing.md * docs/wiki/README.md
1 parent 4264485 commit badb2c8

6 files changed

Lines changed: 32 additions & 25 deletions

File tree

‎.github/CONTRIBUTING.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<!--
2+
SPDX-License-Identifier: CC-BY-SA-4.0
3+
Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
4+
-->
5+
6+
# Contributing Guide
7+
8+
## Getting Started
9+
10+
1. Fork the repository
11+
12+
2. Create a feature branch from `main`
13+
14+
3. Sign off commits (`git` `commit` `-s`)
15+
16+
4. Submit a pull request
17+
18+
## Commit Guidelines
19+
20+
- Conventional commits: `type(scope):` `description`
21+
22+
- Sign all commits (DCO required)
23+
24+
- Atomic, focused commits
25+
26+
## License
27+
28+
Contributions licensed under project license.

‎0-AI-MANIFEST.a2ml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ purpose = """
2121
root-context = "docs/CLAUDE.adoc"
2222
project-state = ".machine_readable/descriptiles/STATE.a2ml"
2323
roadmap = "ROADMAP.adoc"
24-
contributing = "CONTRIBUTING.adoc"
24+
contributing = ".github/CONTRIBUTING.md"
2525
audit-trail = "AUDIT.adoc"
2626
rsr-status = "RSR_COMPLIANCE.adoc"
2727

‎CONTRIBUTING.adoc‎

Lines changed: 0 additions & 21 deletions
This file was deleted.

‎MAINTAINERS.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,4 +62,4 @@ For questions about project governance:
6262

6363
* link:GOVERNANCE.adoc[Governance Model]
6464
* link:CODE_OF_CONDUCT.md[Code of Conduct]
65-
* link:CONTRIBUTING.adoc[Contributing Guide]
65+
* link:.github/CONTRIBUTING.md[Contributing Guide]

‎docs/wiki/Contributing.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
44
-->
55
# Contributing
66

7-
Short summary; the authoritative version is [`CONTRIBUTING.adoc`](../../CONTRIBUTING.adoc) at the root.
7+
Short summary; the authoritative version is [`../../.github/CONTRIBUTING.md`](../../.github/CONTRIBUTING.md) at the root.
88

99
## Language policy (hard rule)
1010

‎docs/wiki/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ that runs the above on every push to main. Tracked in
4949
| `Verification.md` | Build + CI matrix |
5050
| `ABI.md` | Idris2 ABI + DivMod lemma surface |
5151
| `Roadmap.md` | Short; cross-links to ROADMAP.adoc |
52-
| `Contributing.md` | Short; cross-links to CONTRIBUTING.adoc |
52+
| `Contributing.md` | Short; cross-links to ../../.github/CONTRIBUTING.md |
5353
| `Glossary.md` | CNO, =st=, postulate, etc. |
5454
| `FAQ.md` | Common questions |
5555
| `Audit-Trail.md` | Resolved + open audit items |

0 commit comments

Comments
 (0)