Contribute
This shelf is for contributors: how to build Bookclerk, how CI checks a
change, and how to write code documentation and docs pages. The
conventions every change follows are in
AGENTS.md at the root of the repository.
- Build from source and use the CLI: build the binaries and drive Bookclerk from the command line.
- Dev Container: a ready-made build environment.
- Web UI development: the React app, the tray, brand assets, and the UI library reference.
- Visual and accessibility testing: Storybook stories, website and collector pages, axe-core checks and screenshot baselines in CI.
- Continuous integration: the planner, the jobs and
CI Gate. - Fuzzing: fuzz targets in CI and crash triage.
- Repository automation: dependency updates, advisories, docs publishing and Worker deploys.
- Release packaging: platform bundles and release CI.
- Code documentation: how to document Rust, TypeScript, Python and shell.
- Writing docs: how to write a docs page people can read quickly.
- Licensing and the CLA: which license covers what, the contributor agreement and the trademark policy.
- Research notes: store candidates and Libation parity.
- How it works: the architecture behind the code you are changing.
- Design decisions: the records a change may need to update.
Source: docs/contributing/README.md at main · View as Markdown