Part 14 of 16
Contributing
Build it, test it, and land a pull request. Written for someone who does not work here.
- Start hereThe contributor set for the Crux Daemon: who it is for, the repository in one table, the honest state of the on-ramp (zero open issues), and a router that sends you to the right chapter by intent.
- Build from sourceClone the Crux Daemon and get a running binary: the exact prerequisites (protoc is NOT one of them), the verbatim command sequence, the measured build cost including a 178 GB target directory, and eve
- Repository tourWhat lives where in the Crux Daemon repository: the top-level map, all 28 crates with their purpose and size, the verified dependency layering, and a table that turns "I want to change X" into an orde
- Running locallyRun the Crux Daemon on your own machine: dev auth mode, the minimal environment, the corecruxctl commands that matter, and the Docker Compose stack including the overlay that makes console edits live
- TestingEvery test tier in the Crux Daemon: 5,969 tests measured, how to run each tier, roughly how long it takes, and which ones need a live daemon, a nightly toolchain, or the network. Includes the tests yo
- Quality gates and CIThe eleven required checks on main, named exactly; the merge queue and its ruleset; the licence-header, typos, unwrap-ratchet and coverage gates; and the honest limits: CI is self-hosted-only and the
- RecipesOrdered, verified file lists for the five changes contributors actually make to the Crux Daemon: add an HTTP route, an MCP tool, a config flag, an on-disk artifact type, or a test, with the exact test
- Submitting a changeHow to land a pull request on the Crux Daemon: the real commit convention derived from the log, what to do about milestone tags you cannot resolve, the PR template, and the AGENTS.md and repo-manifest
- Licence, security, governanceApache License, Version 2.0, what it permits, what it asks for on redistribution, and the relicense away from the old Community Licence, plus the security disclosure route and the trust contract a con
- Releases and packagingHow a Crux Daemon release is cut, built, gated, signed with cosign, described by a CycloneDX SBOM and SLSA provenance, and shipped: including exactly what assert-no-phone-home.sh asserts and where the
- Good first contributionsThe Crux Daemon has zero open issues and nothing carries its good-first-issue label, so this chapter is the issue tracker: ten grounded first-PR candidates, led by three the maintainers have already p