Contributor documentation
This section is for contributors and maintainers. If you want to install, configure, or use Freehand, start with the user guide.
Start contributing
Section titled “Start contributing”- Set up the repository. Follow the contribution guide for prerequisites, local builds, and pull-request expectations.
- Choose the procedure for your change. Use the guides below for generated assets, compatibility, storage, CI, or releases.
- Validate at the right boundary. Run the required checks and relevant native acceptance on each affected OS and architecture. Record evidence and remaining gaps in the issue or pull request.
Choose the reference for the work you are doing:
Work with GitHub ActionsCI checks, documentation deployment, and release automation.
Prepare a releaseVersioning, Windows and macOS packages, checksums, attestations, and updates.
Update brand assetsCanonical artwork and reproducible platform assets.
Maintain backend compatibilityShared capability catalogs, model contracts, and qualification evidence.
Maintain SQLite storageSchema migrations, generated queries, backups, and credential consistency.
Maintainer references
Section titled “Maintainer references”| If your change touches… | Review |
|---|---|
| Focus, insertion, capture, credentials, or lifecycle | Windows safety invariants |
| Diagnostics or runtime output | Logging contract |
| Native adapters, packaging, permissions, or shutdown | Native Windows and macOS acceptance |