Skip to content

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.

  1. Run from source: the gateway, the web app and the ingest from a checkout.
  2. Architecture and runtimes: one gateway, two runtimes.
  3. Testing & verification: every check and how to run it.
  4. Design notes: the design language, MeshCom integration (design), logging finds over radio and caches on the MeshCom map.
  5. The AX.25 stack: the connected-mode data-link layer.
  6. Shack tools: a tool is a signed tool.json and 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.
  7. Style guide for the manual.
  8. 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