|
| 1 | +== Contributing |
| 2 | + |
| 3 | +Thank you for your interest in contributing! We follow a "`Dual-Track`" |
| 4 | +architecture where human-readable documentation lives in the root and |
| 5 | +machine-readable policies live in `+.machine_readable/+`. |
| 6 | + |
| 7 | +=== How to Contribute |
| 8 | + |
| 9 | +We welcome contributions in many forms: |
| 10 | + |
| 11 | +* *Code:* Improving the core stack or extensions |
| 12 | +* *Documentation:* Enhancing docs or AI manifests |
| 13 | +* *Testing:* Adding property-based tests or formal proofs |
| 14 | +* *Bug reports:* Filing clear, reproducible issues |
| 15 | + |
| 16 | +=== Getting Started |
| 17 | + |
| 18 | +[arabic] |
| 19 | +. *Read the AI Manifest:* Start with `+0-AI-MANIFEST.a2ml+` (if present) |
| 20 | +to understand the repository structure. |
| 21 | +. *Environment:* Use `+guix develop+` or `+direnv allow+` to set up your |
| 22 | +tools. |
| 23 | +. *Task Runner:* Use `+just+` to see available commands |
| 24 | +(`+just --list+`). |
| 25 | + |
| 26 | +=== Development Workflow |
| 27 | + |
| 28 | +==== Branch Naming |
| 29 | + |
| 30 | +.... |
| 31 | +docs/short-description # Documentation |
| 32 | +test/what-added # Test additions |
| 33 | +feat/short-description # New features |
| 34 | +fix/issue-number-description # Bug fixes |
| 35 | +refactor/what-changed # Code improvements |
| 36 | +security/what-fixed # Security fixes |
| 37 | +.... |
| 38 | + |
| 39 | +==== Commit Messages |
| 40 | + |
| 41 | +We follow https://www.conventionalcommits.org/[Conventional Commits]: |
| 42 | + |
| 43 | +.... |
| 44 | +<type>(<scope>): <description> |
| 45 | +
|
| 46 | +[optional body] |
| 47 | +
|
| 48 | +[optional footer] |
| 49 | +.... |
| 50 | + |
| 51 | +Types: `+feat+`, `+fix+`, `+docs+`, `+test+`, `+refactor+`, `+ci+`, |
| 52 | +`+chore+`, `+security+` |
| 53 | + |
| 54 | +=== Reporting Bugs |
| 55 | + |
| 56 | +Before reporting: 1. Search existing issues 2. Check if it’s already |
| 57 | +fixed in `+main+` |
| 58 | + |
| 59 | +When reporting, include: - Clear, descriptive title - Environment |
| 60 | +details (OS, versions, toolchain) - Steps to reproduce - Expected vs |
| 61 | +actual behaviour |
| 62 | + |
| 63 | +=== Code of Conduct |
| 64 | + |
| 65 | +All contributors are expected to adhere to our |
| 66 | +link:CODE_OF_CONDUCT.md[Code of Conduct]. |
| 67 | + |
| 68 | +=== License |
| 69 | + |
| 70 | +By contributing, you agree that your contributions will be licensed |
| 71 | +under the same license as the project (see LICENSE). |
0 commit comments