Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
training:github_asynchronous_workflow [2016/05/15 18:57] kluong |
training:github_asynchronous_workflow [2021/09/19 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== Github Asynchronous Workflow ====== | ====== Github Asynchronous Workflow ====== | ||
| - | One of the advantages (and features) of using git is that you're able to more easily split up the work between you and other members of your team. This page will talk about how you can use Github to work asynchronously. | + | One of the advantages (and features) of using git is that you're able to more easily split up the work between you and other members of your team. This page will talk about how you can use Github to work asynchronously. |
| + | |||
| + | **Steps** | ||
| - Figure out what you want to work on | - Figure out what you want to work on | ||
| - | - Create a new branch for your work | + | - Create a new branch for your work - name the branch with something descriptive. |
| - | - Do some work | + | - Ex. "add-user-page" |
| - | - Push up your branch when you're finished working on it for the day | + | - Do some work. Take a break, do some more work. |
| + | - Push up your branch up regularly, and make sure you push up when you're done working for the day | ||
| - Go to the repository in GitHub and submit a pull request for that branch | - Go to the repository in GitHub and submit a pull request for that branch | ||
| - Name it with that feature that you're working on | - Name it with that feature that you're working on | ||
| - | - "Re-design for front page" | + | - Append WIP (Work in Progress) to the name |
| + | - Ex: "WIP: Re-design for front page" | ||
| + | - Ex: "WIP: Fix bug for | ||
| + | - Take a break or stop working for the day | ||
| + | - Finish your work, push up the branch again | ||
| + | - When you're done **replace** the "WIP" string with "Review: " | ||
| + | - "Review: Re-design for front page" | ||
| + | - Tag someone else for a code review | ||
| + | - Fix any small suggestions they may have | ||
| + | - Leave large changes for another branch if it'll take you a long time | ||
| + | - Remove the "Review" string and merge the pull request | ||
| + | - Delete the branch. | ||
| + | |||
| + | |||
| + | **Reminders** | ||
| + | |||
| + | - Make sure you push up your branch regularly if you're working on it for a couple of days | ||
| + | - Try to always get a code review! It's a good learning experience for everyone | ||
| + | |||
| + | |||
| + | **Comments** | ||
| + | |||
| + | In general, this workflow allows us to work on features during our own time without having to meet together all the time. It's still good to meet together for some features, but the smaller ones can now be handled easier online. If you have any questions you can tag someone directly on the pull request and they can reply there. | ||
| + | |||
| + | **Examples** | ||
| + | |||
| + | These closed pull requests provide some good insight to how the workflow can work: | ||
| + | |||
| + | * https://github.com/scel-hawaii/scel-hawaii.org/pull/19 | ||