Branches
For this project, we will be making use of different types of branches, two long-lived branches; main and development.
- The main branch will contain the production code for the application - never branch of from here. Only the tech-lead (Mentor) will make changes here when appropriate.
- The development branch is where all new features will be developed i.e. you should only create a new branch from here.
The third type of branch will be the feature branches, which is where you will be working most of the time. As stated above, these feature branches should only be made from development and nowhere else.
There is no need to worry about the hotfix and release branches, this will be taken care of by the tech-lead (mentor)
When creating a new branch please name it in the following manner:
<team_name>/feature_description, e.g. team-a/build-text-corpus
To have your code reviewed you will need to submit a pull request. After submitting a pull request, it will be reviewed, it will be sent back for changes if required and only when we are happy with those changes will it be merged into development.
When creating a new pull request (sometimes just called PR) give it the same name as your branch:
-
branch-name:
team-a/build-text-corpus -
PR name:
team-a/build-text-corpus