GitHub flow is the most common git workflow for open-source projects.
Links used in this document
If you have GitHub Desktop or Visual Studio installed, simply click the green Clone or download button above and you'll see the option to Open in Desktop or Open in Visual Studio respectively.
Alternatively, use this command:
git clone https://github.com/pdx-robotics/github-practice.git
The issues page is where you'll find tasks that are looking for help. Issues labeled good first issue are more suitable for newcomers.
Feel free to open a new issue if you found a bug or want to request a new feature. To do this, on the issues page, click the green button New issue.
Once you've found an issue you'd like to work on, let others know by leaving a comment.
In GitHub Desktop, click Branch > New branch (Ctrl + Shift + N).
Alternatively, use this command:
git checkout -b <branch>
At anytime after branching, even before you start working, you can open a pull request (PR). To do this, go to the pull requests page and click the green button New pull request. Select the base branch (usually it's master), and select your branch to compare with base. Then click Create pull request.
If your branch is not yet ready to merge, put a [WIP] at the begining of the title. Then click Create pull request one more time.
When your branch is ready to merge, remove [WIP] from the title and start the discussion by requesting reviews. In the right sidebar under Reviewers there should be some people suggested. Simply click Request and wait. To request someone not suggested, click the gear icon and select their username.
You may now contact your reviewers by email, Discord, or talk to them in person.
Your reviewers will then leave comments, approve your PR, or request changes. Read all feedback carefully, even if your PR has already been approved.
With enough approvals, an admin or someone with write permissions will merge your PR. If you were working on an issue, you can now leave a comment and close the issue.