Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.
The issue tracker is the preferred channel for issue/bug reports, feature requests, questions and submitting pull requests.
A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!
Guidelines for issue/bug reports:
- Use the GitHub issue search — check if the issue has already been reported
- Check if the issue has been fixed — try to reproduce it using the latest
masterordevelopbranch in the repository - Truemail issue template/bug template
A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What would you expect to be the outcome? All these details will help people to fix any potential bugs.
Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.
We're always open to a new conversations. So if you have any questions just ask us.
Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.
Please ask first before embarking on any significant pull request (e.g. implementing features, refactoring code, porting to a different language), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.
Please adhere to the coding conventions used throughout a project (indentation, accurate comments, etc.) and any other requirements (such as test coverage). Not all features proposed will be added but we are open to having a conversation about a feature you are championing.
Guidelines for pull requests:
- Truemail pull request template
- Fork the repo, checkout to
developbranch - Run the tests. This is to make sure your starting point works
- Read our branch naming convention
- Create a new branch
- Read our setup development environment guide
- Make your changes. Please note that your PR should include tests for the new codebase!
- Push to your fork and submit a pull request to
developbranch