Contributing¶
Thank you for considering contributing to Terranova! This section covers how to get set up for development and how to submit contributions.
Ways to contribute¶
- Bug reports — open an issue on GitHub with steps to reproduce
- Feature requests — open an issue describing the use case
- Pull requests — see the guides below for how to set up a development environment and submit code
Development guides¶
| Guide | Description |
|---|---|
| Development Setup | Set up your local dev environment |
| Testing | Run the test suite |
| Code Style | Formatting and linting rules |
| Project Structure | Directory layout explained |
| Build Notes | Vite build and frontend build system notes |
Pull request process¶
- Fork the repository and create a branch from
main - Make your changes, including tests for any new behavior
- Ensure all tests pass (
make test) - Ensure code style checks pass (
pre-commit run --all-files) - Open a pull request against
mainwith a clear description of the change