First of all, thank you for contributing, you are awesome!
Before starting to contribute, you should read the following:
Report bugs at https://github.com/TailorDev/monod/issues/new.
When reporting a bug, please include:
- Any details about your local setup that might be helpful in troubleshooting;
- Detailed steps to reproduce the bug. When possible, please write a test case.
Check out the open bugs - anything tagged with the [easy pick] label could be a good choice for newcomers (and we are willing to help you).
Look through the GitHub issues for features. Anything tagged with [enhancement] is open to whoever wants to implement it.
Any issue with the [question] label is open for feedback, so feel free to share your thoughts with us!
The best way to send feedback is to fill a new issue on GitHub.
If you are proposing a feature:
- Explain how you envision it working. Try to be as detailed as you can;
- Try to keep the scope as narrow as possible. This will help make it easier to implement;
- Feel free to include any code you might already have, even if it's just a rough idea. This is a volunteer-driven project, and contributions are welcome :)
Here are a few rules to follow in order to ease code reviews, and discussions before maintainers accept and merge your work:
- you MUST run the test suite;
- you MUST write (or update) unit tests;
- you SHOULD write documentation.
Please, write commit messages that make sense, and rebase your branch before submitting your Pull Request.
One may ask you to squash your
commits
too. This is used to "clean" your Pull Request before merging it (we don't want
commits such as fix tests, fix 2, fix 3, etc.).
Also, while creating your Pull Request on GitHub, you MUST write a description which gives the context and/or explains why you are creating it.
Thank you!