Skip to content

Commit 541e17f

Browse files
hyperpolymathclaude
andcommitted
chore: add CONTRIBUTING.adoc (RSR compliance)
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 7a0a1e9 commit 541e17f

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

CONTRIBUTING.adoc

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
= Contributing to AcceleratorGate.jl
2+
:toc: preamble
3+
:icons: font
4+
5+
This document explains how to contribute to the project. We follow a "Dual-Track" architecture where human-readable documentation lives in the root and machine-readable policies live in `.machine_readable/`.
6+
7+
== How to Contribute
8+
9+
We welcome contributions in many forms:
10+
* **Code:** Improving the core verified stack or extensions.
11+
* **Documentation:** Enhancing AsciiDoc manuals or AI manifests.
12+
* **Testing:** Adding property-based tests or formal proofs.
13+
14+
== Getting Started
15+
16+
1. **Read the AI Manifest:** Start with `0-AI-MANIFEST.a2ml` to understand the repository structure.
17+
2. **Environment:** Use `nix develop` or `direnv allow` to set up your tools (Idris2, Zig, Rust).
18+
3. **Task Runner:** Use `just` to see available commands (`just --list`).
19+
20+
== Contribution Policies
21+
22+
For detailed rules on branch naming, commit messages, and the PR process, please refer to the machine-readable manual at link:.github/CONTRIBUTING.md[CONTRIBUTING.adoc].
23+
24+
== Code of Conduct
25+
26+
All contributors are expected to adhere to our ethical standards. See link:.github/CODE_OF_CONDUCT.md[CODE_OF_CONDUCT.adoc] for details.

0 commit comments

Comments
 (0)