Branching and Merging

Branching and Merging policy

Basically we have to branches which will always exist. master and develop. These branches represent prod and beta respectively.

Creating a new feature

When creating new work items you branch from develop into a feature branch. The name of the feature branch should be something in the format of feature-[SOME DESCRIPTIVE NAME HERE].

Finishing on a feature

When you finish a feature (and have added tests) you should:

1. Pull the current head (the latest version) of the develop branch into the feature branch
2. Ensure the feature branch still works with the latest develop
3. Submit a merge request to develop (for someone else to test and approve), ensure there are details on the description of the merge request
4. Merge request should be accepted by someone else after testing

Creating a new bug fix

Ensure a github issue exists for the bug, note this should only be for bugs which exist in develop. Once the issue is created and is descriptive, branch from develop with the branch name issue-[ISSUE NUMBER].

Finishing a bug fix

1. Pull the current head (the latest version) of the develop branch into the issuebranch
2. Ensure the issue branch still works with the latest develop
3. Submit a merge request to develop (for someone else to test and approve), ensure the merge request mentions Closes #[Issue number] you don't need to add more details unless something differs from the details on the issue
4. Merge request should be accepted by someone else after testing