Thank you for investing your time in contributing to our projects!
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.
Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly.
To get an overview of the projects, please consult our Overview.
To get started with reporting issues / bugs, filing requests please check out the respective project page. This will feature an 'Issues' tab and links to other resources. For contributions to discussions, please check our organization's Discussion Board.
To get started with open source contributions, please check the following resources:
- Finding ways to contribute to open source on GitHub
- Set up Git
- GitHub flow
- Collaborating with pull requests
If you spot a problem with the docs, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.
Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. See Labels for more information. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
Click Make a contribution at the bottom of any docs page (you need to have a GitHub account and be logged in) to make small changes such as a typo, sentence fix, or a broken link. This takes you to the .md file where you can make your changes and create a pull request for a review.
-
Install Git LFS. This may be necessary for some of our repositories, but it does not hurt to have it anyway 😁
-
Fork the repository.
-
Using GitHub Desktop:
- Getting started with GitHub Desktop will guide you through setting up Desktop.
- Once Desktop is set up, you can use it to fork the repo!
-
Using the command line:
- Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.
-
Check the project repository's README.md for more instructions to install / build the software.
-
Create a working branch and start with your changes!
-
Commit the changes once you are happy with them.
-
Please make sure that the project can be built locally and tests are running (if tests exist in the project). If true, go to 5., else go to 3.
-
Fix any build or test errors (again: if applicable).
-
go to 1.
-
Push your changes 🤞
When you're finished with the changes, create a pull request, also known as a PR.
- Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
- Don't forget to link PR to issue if you are solving one.
- Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a team member will review your proposal. We may ask questions or request for additional information.
- We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
- As you update your PR and apply changes, mark each conversation as resolved.
- If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.
:party: Yeah! Thank you for your contribution!
Once your PR is merged, your contributions will be publicly visible in the respective project and will be included in any upcoming release. Your GitHub user name will be automatically listed under "Contributors" of that project.
This contribution guide was adapted from the GitHub Docs contribution guide.