Contribution's are always welcome! Just:
- Fork the repository you'd like to contribute to
- Checkout your forked repository. Your repository will have upstream set to the original repository, and origin will be your own repository on Github.
- You will need to sync your repository with the upstream one from time to time, because things will change on the upstream repository.
- Create a Pull Request for your changes against the original repository
To keep code quality high and maintainable, we've set up a few guidelines to help you ✨
-
Automated tools - We rely heavily on automated tools to keep our projects maintainable, so please make sure you've added test cases if necessary and linted your code.
-
Logging - Only log errors if it's actually an error: An errors is something needs to be fixed by a developer.
- These should be
warnings, not errors: Bad user input. Bad config that can be solved by changing settings via a UI. - These are actual
errors: A request failed. An async job failed after it's max retries.
- These should be
(This document is still a work in progress...)