Viewing is open to everyone. Downloading and starring need a GitHub sign-in.
Sign in with GitHub
CONTRIBUTING.md
v0.1.0-build.85
Latest
Commit ede38f5
Sign in with GitHub to download. Each download is recorded with your GitHub username.
| 1 | # Contributing |
| 2 | |
| 3 | Thank you for helping with CKey. |
| 4 | |
| 5 | ## Where changes go |
| 6 | |
| 7 | | Branch | What it is | |
| 8 | |---|---| |
| 9 | | `Stable-Release` | The supported source. Releases are tagged only here. | |
| 10 | | `community` | Experimental community work. Open pull requests against this branch. | |
| 11 | | `scratch` | The maintainer's working branch. | |
| 12 | |
| 13 | 1. Fork the repository and branch from `Stable-Release`. |
| 14 | 2. Make your change, with tests. |
| 15 | 3. Open a pull request against `community`. |
| 16 | |
| 17 | The maintainer promotes reviewed work towards `Stable-Release`. See [docs/BRANCHES-AND-RELEASES.md](docs/BRANCHES-AND-RELEASES.md). |
| 18 | |
| 19 | ## Building and testing |
| 20 | |
| 21 | ```sh |
| 22 | cmake -S . -B build -DCMAKE_BUILD_TYPE=Release |
| 23 | cmake --build build -j |
| 24 | ctest --test-dir build --output-on-failure |
| 25 | python3 tools/check_version.py |
| 26 | ``` |
| 27 | |
| 28 | The SDKs have their own builds and tests; see each `sdk/*/README.md`. |
| 29 | |
| 30 | ## Rules |
| 31 | |
| 32 | - **Versioning.** Every change that ships bumps the build number: `python3 tools/bump_version.py`, then add a `CHANGELOG.md` entry. The full rules are in [CONTRIBUTING_VERSIONING.md](CONTRIBUTING_VERSIONING.md). |
| 33 | - **Formats.** A change to geometry, framing, error correction or decoding needs a format-version change and a specification update under `spec/`. |
| 34 | - **Evidence.** Do not claim robustness, speed, capacity or interoperability without results from the benchmark and fixture procedures in `docs/benchmarks/`. |
| 35 | - **Licence.** Contributions are accepted under the MIT licence in [LICENSE](LICENSE). Do not copy code whose licence you have not checked. |