Git Conventions

Branches:

main:

• The main branch is the branch where the Minimal Viable Product will be pushed to.
• The only branch allowed to merge to the main branch is develop.
• When merging from develop to main it must have been reviewed by at least two collaborators.
• When merging from develop to main there must be zero mergeconflicts.
• When merging from develop to main there must be zero open reviews on the pullrequest.

develop:

• Develop is the default branch for adding everything together before it goes to main.
• All branches are allowed to merge to develop.
• When merging to develop the feature must have been tested on the feature branch with develop pulled.
• When merging to develop it must have been reviewed by at least one collaborator.
• When merging to develop there must be zero mergeconflicts.
• When merging to develop must be zero open reviews on the pullrequest.

feature branch:

• Feature branches are the branches in which you create features from userstories.
• Feature branches can only be made from Develop.

bug branch:

• Bug branches are meant to be made from Develop. Any bugs found in a feature branch must be resolved there.
• Bug branches, before being merged, must not only be reviewed, but also tested in the engine.

prototype branch:

• A prototype branch is to be made for testing, and prototyping if the Feature branch is stable.
• A prototype branch can only be made from a Feature branch.
• When a prototype branch is successful, it can be merged into the respective Feature branch, or removed altogether if the branch was exclusively used for testing.

Git naming conventions:

Directory names are PascalCase, while the branch name is camelCase.

• When working on a feature the directory name is Feature.

Example: Feature/featureName

• When working on art the directory name is Art.

Example: Art/artName

• When working on a bug the directory name is Bug.

Example: Bug/bugName

Pull request conventions:

• Before making a pull request the feature must have been tested with develop pulled to the feature branch.
• After a pull request is complete, and it's been confirmed that that branch is no longer needed, the branch is to be removed (Any removed branches can be found under Insight/Network here on the Github page).
• Bugs, if found during testing, are not allowed to be pushed to Develop. These must be fixed before the process may continue.
• If the bug is found after the merge, or if it's a fundamental issue, these must be resolved on a separate branch (Bug/bugName).
• Reviews in the Pull Request must be disclosed with an explanation, feedback and a code snippet highlighted.
• Reviews must be concise. If there's any confusion with any feedback given under a pull request, a comment can be left under the review, or they can be approached in real life.

Push conventions:

• A push commit must be concise, explaining what the push does in a short manner.
• A push must be performed at the end of the day.
• Or upon completion of a To Do on the Trello.