2024-05-21 19:03:48 +00:00
# Process
2024-06-26 02:55:03 +00:00
## Ticket Management
2024-05-21 19:03:48 +00:00
2024-06-26 02:55:03 +00:00
We use GitHub projects to manage our work.
You can find our board [here ](https://github.com/orgs/sartography/projects/3 ), and issues can be filed [here ](https://github.com/sartography/spiff-arena/issues ).
2024-05-21 19:03:48 +00:00
## CI
2024-06-26 02:55:03 +00:00
We use GitHub Actions for CI.
2024-05-21 19:03:48 +00:00
The workflows are defined in the `.github/workflows` directory.
The main things that happen, not necessarily in this order, are represented in this chart:
```mermaid
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
```
2024-06-26 02:55:03 +00:00
2024-05-21 19:03:48 +00:00
## Security
We have security checks in place for both the backend and the frontend.
2024-06-28 15:03:25 +00:00
These include the security library in the backend, and Snyk in the frontend and backend.
2024-06-26 02:55:03 +00:00
Two independent security reviews have been performed on the codebase, and mitigations have been implemented to the satisfaction of the reviewers.
2024-05-21 19:03:48 +00:00
## Contributing
2024-06-18 17:24:31 +00:00
This is the last page in the Technical Documentation section, where we keep content mainly intended for developers.
2024-06-26 02:55:03 +00:00
And that seems like as good a place as any to mention that it would be great to have you contributing to the project!
2024-05-21 19:03:48 +00:00
There is a [Contributing doc ](https://github.com/sartography/spiff-arena/blob/main/CONTRIBUTING.rst ) that you can follow.
You can find other like-minded people in our [Discord ](https://discord.gg/F6Kb7HNK7B ).
2024-06-18 17:24:31 +00:00
Thank you!
2024-05-21 19:03:48 +00:00
```mermaid
graph LR
code[Hammer code] --> PR
PR --> Profit
```