Thanks ✨ for investing your time in contributing to this project!
Read our Code of Conduct to keep our community approachable and respectable.
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
To get an overview of the project, read the README file. Here are some resources to help you get started with open source contributions:
- Finding ways to contribute to open source on GitHub
- Set up Git
- GitHub flow
- Collaborating with pull requests
Please accept that we regret that we cannot offer any help with using standard tools.
Before making changes please verify the accepted ways to contribute:
Issues are used to track tasks that contributors can help with.
If you've found something in the content or the website that should be updated, search open issues to see if someone else has reported the same thing. If it's something new, open an issue. We'll use the issue to have a conversation about the problem you want to fix.
Scan through our existing issues to find one that interests you. As a general rule, we don’t assign issues to anyone. If you find an issue you want to work on, you are welcome to open a pull request with a fix. If a related issue doesn't exist, you can open a new issue using a relevant issue form.
A pull request is a way to suggest changes in our repository. When we have time we merge those changes.
Recommended procedure:
- Make changes locally
- Fork the repository.
- Create a working branch and start with your changes!
- Commit your update, the changes once you are happy with them.
- Create a pull request, when you're finished with the changes.
- Celebrate, when your pull request is merged! 🎉🎉 Thanx. Once your pull request is merged, your contributions will be publicly visible on the project.