Thank you for investing your time in contributing to this project!
Read our Contributor Covenant 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:
Here are the types of contributions we are looking for:
- Any problems (bugs) with the code.
- Updates to the documentation. For example improved wording, broken links, etc.
- A suggested feature to improve the app itself.
Your options here are to 1. Create an new Issue or 2. Solve an Issue.
What are GitHub Issues?
-
GitHub Issues are items you can create in a repository to plan, discuss and track work.
-
More info with this 1 minute video.
-
And more detail with this 7 minute video.
If you observe a problem with this repo that falls into one of the three types listed above (see the Types of contributions we're looking for section above), please first see if that issue already exists.
How to search for an Issue already exists?
If that Issue already exists, feel free to add any new info to that Issue via the comments in that Issue.
And if that Issue does not already exist, please create a new GitHub Issue.
How to create a new GitHub Issue
- GitHub documentation
- This 7 minute video.
If a related issue doesn't exist, you can open a new issue using a relevant issue form.
Another option to contribute to is solve an existing issue.
Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. See "Label reference" 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. (What are Labels? More info here.)
How to find a GitHub Issue to work on?
- This GIT issues solving procedure Gist is a concise list in order of what needs to be done.
- This WORKING ON YOUR FIRST GITHUB ISSUE article is thorough.
- A Git and Github: Working on an Issue 6 minute YouTube video.
For more information about using a codespace for working on GitHub documentation, see "Working in a codespace."
- 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.
- Create a working branch and start with your changes!
Commit the changes once you are happy with them. Don't forget to use the "Self review checklist" to speed up the review process ⚡.
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 Docs team member will review your proposal. We may ask questions or request 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.
Congratulations 🎉🎉 Thank you!
I am currently a one-man "team". As such, any and all questions, comments, and suggestions are welcome. Please reach out to me.
Note - This file was heavily borrowed from the Welcome to GitHub docs contributing guide and adapted here.