Issues Workflow

1. Every change to the system must be associated with an issue in the GitHub system.
2. Every issue in the system must have an associated branch name ISSUE_<issue number> e.g. ISSUE_105
3. Small subtasks, with different issue numbers, can be grouped under a single feature branch. However, the feature must be its own separate issue and linked to the subtasks with the syntax in the wiki link below. The branch name must use the number given to the feature issue.
4. Every commit message should be prepended by the branch name. Such as:

ISSUE #105 - Changed variable name.

Information on linking issues together via commit messages, and closing issues can be found on GitHub Issues Wiki

Creating a Issue Branch

1. First checkout staging to branch off of

   git checkout staging

2. Then create a branch with the name convention above

   git checkout -b ISSUE_1

3. Then push the newly created branch to GitHub

   git push -u origin ISSUE_1

Updating branch

1. Once you have made the relevant changes then add all the files to commit

   git add <filename>

   or

   git add -a

   to add all files.

2. Then commit the changes

   git commit

3. Fill in the message in the text editor that appears, prepend all commit messages with ISSUE # where number is the issuer number.

   ISSUE #1 - Fix a bug in the login page

4. Finally push the changes to the server

   git push

5. At this point you may need to resolve merge conflicts.

Merge conflicts

1. After a git push command there might be a message about changes upstream. To merge these run a pull command:

   git pull

2. Git will attempt to auto-merge the changes, but may conflict.

3. To resolve the conflicts you must go through the conflicted files and look for sections such as:

   <<<<<<<<<<<<<<<<<<<<<<<<<<<

   var self = this;

   ============================

   var self = that;

   >>>>>>>>>>>>>>>>>>>>>>>>>>>>

4. Delete and merge lines as necessary and then follow the updating branch procedure above.