Process¶

Ticket Management¶

We use GitHub projects to manage our work. You can find our board here, and issues can be filed here.

CI¶

We use GitHub Actions for CI. The workflows are defined in the .github/workflows directory. The main things that happen, not necessarily in this order, are represented in this chart:

flowchart LR subgraph "backend_tests"[Backend Tests] pytest[Pytest] mypy[MyPy] safety[Safety] black[Black] typeguard[TypeGuard] end subgraph "frontend_tests"[Frontend Tests] vitest[Vitest] eslint[ESLint] prettier[Prettier] cypress[Cypress] end backend_tests --> frontend_tests frontend_tests --> docker_images

Security¶

We have security checks in place for both the backend and the frontend. These include the security library in the backend, and Snyk in the frontend and backend. Two independent security reviews have been performed on the codebase, and mitigations have been implemented to the satisfaction of the reviewers.

Contributing¶

This is the last page in the Technical Documentation section, where we keep content mainly intended for developers. And that seems like as good a place as any to mention that it would be great to have you contributing to the project! There is a Contributing doc that you can follow. You can find other like-minded people in our Discord. Thank you!

graph LR code[Hammer code] --> PR PR --> Profit