Contribute¶
This section is for people who change APRScaching: the code, the tests and this manual. Start with a running checkout, then read where your change belongs.
- Run from source: the gateway, the web app and the ingest from a checkout.
- Architecture and runtimes: one gateway, two runtimes.
- Testing & verification: every check and how to run it.
- Design notes: the design language, MeshCom integration (design), logging finds over radio and caches on the MeshCom map.
- The AX.25 stack: the connected-mode data-link layer.
- Shack tools: a tool is a signed
tool.jsonand a script that the Tools app runs in a sandbox, published in a registry, with no change to this repository. The tools site holds everything for tool authors and publishers: Write your first tool, the manifest, the sandbox API, API versions, publish a registry and contribute a tool to the project registry. Using tools is under Tools and plugins. - Style guide for the manual.
- Specification registry: what is built from which open specification.
Contributions are inbound = outbound: each one is licensed under the licence of the unit it changes
(About). Commits carry a DCO sign-off (git commit -s).
CONTRIBUTING.md sets out the branch flow,
Conventional Commits and the pull-request checklist.
Next¶
- Run from source: get a checkout running.
- Architecture and runtimes: where a change belongs.