Thank you for your interest in contributing to Azimuth!
This document should be able to guide contributors in their different types of contributions.
ℹ️ Just want to ask a question? Open a topic on our Discussion page.
Azimuth is split in two components. Go to our Setup to get setup on both the frontend and backend.
It is encouraged to be familiar with our development best practices.
When everything is set up, you can refer to the Launching section to launch Azimuth locally or on Docker.
Open an issue on Github and select "Bug report". If you are not sure whether it is a bug or not, submit an issue and we will be able to help you.
Issues with reproducible examples are easier to work with. Do not hesitate to provide your configuration with generated data if need be.
If you are familiar with the codebase, providing a "unit test" is helpful, but not mandatory.
First, open an issue describing your desired changes. This is especially important if you need to add a new dependency. If that is the case, please mention which package and which version you would like to add.
Once a member accept your proposition, you can start coding!
- Fork the repo to your own account.
- Clone your fork of the repo locally.
- Make your changes (the fun part).
- Commit and push your changes to your fork.
- Open a pull-request with your branch.
- Once a team member approves your changes, we will merge the pull request promptly.
If you need help, feel free to reach out to a team member or through a GitHub Discussion. If the team member can't answer your question, they will find someone who can!
- Frederic Branchaud-Charron @Dref360
- Gabrielle Gauthier-Melancon @gabegma
- Joseph Mariner @JosephMarinier
- Chris Tyler @christyler3030
- LindsayBrin @lindsaydbrin
- Nandhini Babu @nandhinibsn
We would love to add you to this list!
To reach out to the owners of this project, please see our About page.