Developer guidelines
How to set the project up, build it, test it and ship it.
| Document | Covers |
|---|---|
setup.md |
The tools to install and how to get a first run. |
scripts.md |
The pnpm commands and what each does. |
coding-standards.md |
Where code belongs, and the rules it follows. |
testing.md |
Unit tests, type checks and pre-commit hooks. |
packaging.md |
Building a full .app bundle for local use. |
debugging.md |
Attaching to a running app and querying Gmail's page. |
ci-and-releases.md |
The self-hosted runner and the release pipeline. |
documentation.md |
How the docs are published as a site. |
workflow.md |
Issues, branches, pull requests and the project board. |
The architecture these guidelines build against is in ../shared/,
../magimail/ and ../magical/.