First of all, thank you for contributing. Contributions help keep the guide up-to-date and make the guide better. Contributions are always welcome.
The following is a set of guidelines for contributing to the guide. These are guidelines, not hard rules.
- Make sure you are up to date with the latest changes. It is recommended you pull the latest changes from the master branch before working on your own.
- Make sure to test your changes before submitting a pull request.
- In the guide, make sure to explain everything in a way that is easy to understand. If it's an advanced guide that required some expertise, explain that in a note admonition.
- Make sure you follow proper grammar and spelling.
- Try to follow the guide's style.
- Try to follow git conventions. If you are not familiar with git, you can find a good tutorial here.
By submitting a pull request, you agree:
- That you are submitting your own work. You hold the copyright to your work.
- To transfer your copyright to the guide.
- To license your contribution under the MIT License.
- If you are found to be in fault with any of the above, we shall not be held responsible in any way after the pull request has been merged.