Skip to content

Commit 92b8b74

Browse files
committed
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. Committed through the git index rather than a worktree: this repository carries very large training-data blobs whose checkout exceeds the runner's writable space, so the change is applied with `git apply --cached` and written with `git write-tree`.
1 parent ccc52d1 commit 92b8b74

9 files changed

Lines changed: 97 additions & 31 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
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+
# Getting started
6+
```bash
7+
git clone https://github.com/hyperpolymath/echidna.git
8+
cd echidna
9+
10+
# Using mise (recommended: provision the pinned toolchain)
11+
mise install
12+
13+
# Task runner (see Justfile)
14+
just --list # available tasks
15+
just check # verify setup / static checks
16+
just test # run the test suite
17+
```
18+
19+
---
20+
21+
## How to Contribute
22+
23+
### Reporting Bugs
24+
25+
**Before reporting**:
26+
1. Search existing issues
27+
2. Check if it's already fixed in `main`
28+
3. Determine which perimeter the bug affects
29+
30+
**When reporting**:
31+
32+
Use the [bug report template](.github/ISSUE_TEMPLATE/bug_report.md) and include:
33+
34+
- Clear, descriptive title
35+
- Environment details (OS, versions, toolchain)
36+
- Steps to reproduce
37+
- Expected vs actual behaviour
38+
- Logs, screenshots, or minimal reproduction
39+
40+
### Suggesting Features
41+
42+
**Before suggesting**:
43+
1. Check the [roadmap](../docs/status/ROADMAP.adoc) if available
44+
2. Search existing issues and discussions
45+
3. Consider which perimeter the feature belongs to
46+
47+
**When suggesting**:
48+
49+
Use the [feature request template](.github/ISSUE_TEMPLATE/feature_request.md) and include:
50+
51+
- Problem statement (what pain point does this solve?)
52+
- Proposed solution
53+
- Alternatives considered
54+
- Which perimeter this affects
55+
56+
### Your First Contribution
57+
58+
Look for issues labelled:
59+
60+
- [`good first issue`](https://github.com/hyperpolymath/echidna/labels/good%20first%20issue) — Simple Perimeter 3 tasks
61+
- [`help wanted`](https://github.com/hyperpolymath/echidna/labels/help%20wanted) — Community help needed
62+
- [`documentation`](https://github.com/hyperpolymath/echidna/labels/documentation) — Docs improvements
63+
- [`perimeter-3`](https://github.com/hyperpolymath/echidna/labels/perimeter-3) — Community sandbox scope
64+
65+
---
66+
67+
## Development Workflow
68+
69+
### Branch Naming
70+
```
71+
docs/short-description # Documentation (P3)
72+
test/what-added # Test additions (P3)
73+
feat/short-description # New features (P2)
74+
fix/issue-number-description # Bug fixes (P2)
75+
refactor/what-changed # Code improvements (P2)
76+
security/what-fixed # Security fixes (P1-2)
77+
```
78+
79+
### Commit Messages
80+
81+
We follow [Conventional Commits](https://www.conventionalcommits.org/):
82+
```
83+
<type>(<scope>): <description>
84+
85+
[optional body]
86+
87+
[optional footer]
88+
```

.github/canonical-references/prover-counts.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ scope:
3939
- EXPLAINME.adoc
4040
- CLAUDE.md
4141
- CONTRIBUTING.md
42-
- CONTRIBUTING.adoc
42+
- ../../.github/CONTRIBUTING.md
4343
- QUICKSTART-USER.adoc
4444
- QUICKSTART-DEV.adoc
4545
- QUICKSTART-MAINTAINER.adoc

CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Guidelines and context for working with Claude Code on the ECHIDNA project.
1919
- **Environment variables**: [`docs/ENV-VARS.md`](docs/ENV-VARS.md)
2020
- **RSR / CCCP compliance statement**: [`RSR_COMPLIANCE.adoc`](RSR_COMPLIANCE.adoc)
2121
- **Receipts for README claims**: [`EXPLAINME.adoc`](EXPLAINME.adoc)
22-
- **Contributor guide**: [`CONTRIBUTING.adoc`](CONTRIBUTING.adoc)
22+
- **Contributor guide**: [`.github/CONTRIBUTING.md`](.github/CONTRIBUTING.md)
2323

2424
## Repository Structure
2525

CONTRIBUTING.adoc

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

GOVERNANCE.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ratified. GitHub renders AsciiDoc directly.
88
Related:
99

1010
* link:MAINTAINERS.adoc[`+MAINTAINERS.adoc+`] — who maintains what
11-
* link:CONTRIBUTING.adoc[`+CONTRIBUTING.adoc+`] — contribution process
11+
* link:.github/CONTRIBUTING.md[`+.github/CONTRIBUTING.md+`] — contribution process
1212
* link:CODE_OF_CONDUCT.md[`+CODE_OF_CONDUCT.md+`] — expected conduct
1313
* link:RSR_COMPLIANCE.adoc[`+RSR_COMPLIANCE.adoc+`] — compliance
1414
statement

NOTICE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ CONTRIBUTIONS
147147
Contributions are licensed under the licence governing the part of the tree
148148
they land in: AGPL-3.0-or-later for application code, MPL-2.0 for the
149149
machine-readable specification surface and echidna-playground/, and
150-
CC-BY-SA-4.0 for documentation. See CONTRIBUTING.adoc.
150+
CC-BY-SA-4.0 for documentation. See .github/CONTRIBUTING.md.
151151

152152
By contributing, you certify that:
153153
1. You have the right to submit the contribution.

QUICKSTART-DEV.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,9 +92,9 @@ just assail # panic-attacker security scan (requires panic-attack CLI)
9292
----
9393

9494
All commits must be GPG-signed and follow Conventional Commits — see
95-
link:CONTRIBUTING.adoc[`CONTRIBUTING.adoc`] for the full policy.
95+
link:.github/CONTRIBUTING.md[`.github/CONTRIBUTING.md`] for the full policy.
9696

9797
== Contributing
9898

99-
See link:CONTRIBUTING.adoc[CONTRIBUTING.adoc] for guidelines (the
99+
See link:.github/CONTRIBUTING.md[.github/CONTRIBUTING.md] for guidelines (the
100100
canonical, AsciiDoc version). `CONTRIBUTING.md` is a thin pointer.

docs/DEBT.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,15 +84,15 @@ gh repo view hyperpolymath/echidna --json licenseInfo
8484

8585
Seven files (later found to be 29) carried `+Palimpsest-0.6+` in their
8686
SPDX identifier. The owner ruled these were never a deliberate legal
87-
grant: `+CONTRIBUTING.adoc+` already recorded that the Palimpsest
87+
grant: `+../.github/CONTRIBUTING.md+` already recorded that the Palimpsest
8888
licence proper "`is the legal licence only on `+palimpsest-license+`,
8989
`+palimpsest-plasma+`, and (prospectively) `+consent-aware-http+``", and
9090
that in ECHIDNA it is an _ethical framework_ reference, orthogonal to
9191
the SPDX choice. Version 0.6 is also superseded by the
9292
`+hyperpolymath/palimpsest-license+` repository.
9393

9494
All Palimpsest SPDX identifiers were therefore removed. The framework
95-
reference is preserved in `+CONTRIBUTING.adoc+` and `+NOTICE+`, which
95+
reference is preserved in `+../.github/CONTRIBUTING.md+` and `+NOTICE+`, which
9696
now state explicitly that it is not a grant, so this cannot drift back
9797
in silently.
9898

echidna-playground/README.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -382,7 +382,7 @@ deno task test:proofs
382382

383383
== Contributing
384384

385-
We welcome contributions! Please see link:CONTRIBUTING.adoc[CONTRIBUTING.adoc] for guidelines.
385+
We welcome contributions! Please see link:../.github/CONTRIBUTING.md[../.github/CONTRIBUTING.md] for guidelines.
386386

387387
=== Development Philosophy
388388

0 commit comments

Comments
 (0)