GitHub-Flow-sample-document

Sample document with procedure for how to use Github flow for a small team

Github is the centralized repository that will be used. www.github.com

The organization is: https://github.com/your_org_here

The main reporting repository is: https://github.com/your_org_here/your_repo

Workflows will all start with creating an issue in GitHub to track the impending change. This way, everyone will be able to keep track of which scripts are being worked on by whom, and what issues in current scripts need to be resolved.

Creating your local version of the repo to work on

Only needs to be done once

Click on the Fork button to create your own copy of the repo in your own Github account
You will now have a copy of the repo in your account to work on
Clone your repo from your account to your desktop (e.g. git clone url folder command). Github does have a Windows tool that some may find useful.
Add an upstream remote to the main repo (you only have to do this once for your local repo and will be used for keeping your info up to date):

git remote add upstream https://github.com/your_org_here/your_repo

Adding or Revising the Repo

New script

Navigate to the issues page of the main repo:

https://github.com/your_org_here/your_repo/issues

Click on new issue
Add a descriptive title and comments about what changes you intend on making
Add yourself as assignee on the right hand side
Add the appropriate tags (e.g. new script)
Click on submit issue

Enhancement of existing script/bug fix

Navigate to the issues page of the main repo:

https://github.com/your_org_here/your_repo/issues

Click on new issue
Add a descriptive title and comments about what changes you intend on making

In the body add a link to the script
In the title add the name of the script.
If you are going to fix the issue, add yourself as assignee on the right hand side

Add the appropriate tags (e.g. bug fix, enhancement)
Click on submit issue

Making the changes

In your forked copy of the repo

Create a branch with a terse description on what the branch is for as the title of the branch

git checkout –b new_branch_terse_desc

Complete the revisions/additions to the code to your local copy
Ensure your local copy is up to date before pushing (see Keeping your local and fork up to date)
Push your changes to your forked repo on Github (you will now be ready to create a pull request to merge the changes into the main repo)

Git push origin new_branch_terse_desc

Keeping your local and fork up to date

Since there may have been updates to the main repository since you started working on your new code, it is important to get your local branch and forked copy of master current. At this point you would have already created the new branch and done some work. You should commit that work:

git commit –m “message here”

Update your forked copy of master (on github)

git fetch upstream
git checkout master
git merge upstream/master
git push origin master

Update the starting point for your local changes

git fetch upstream
git checkout feature_branch
git rebase master If git cannot rebase, you will get merge conflicts that you have to resolve.
Get the rebase done (one way to fix the merge conflict)
fix the file where the merge conflict occurred. There will be indicators in the file about where the changes are.
git add filename
git rebase –continue More info: https://help.github.com/articles/resolving-a-merge-conflict-from-the-command-line/

Initiating pull requests

Go to your forked repo on Github
Click the compare and review button
Base will be ‘master’ (the default branch), as that will be the one main branch with the most up to date status.
Click create pull request

be sure to add the issue # that you created when starting the work in the commit message to close the issue (e.g. the changes I provided here closes #5)
closes, close, closed, fix, fixes, resolves are all keywords for closing issues

ivan7707/GitHub-Flow-sample-document