Git rules

Branches and commit messages

For this project, we use Feature branches with Pull Requests for merging into master. (Source: https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow)

Branch naming conventions

feature/your-branch-name : any work on a feature of the project

bugfix/your-branch-name : any work on a bug of the project

Commit messages convention

The commit message must describe explicitly what are your changes. Those changes must address only one specific task.

Example

Let's say we want to add an exit button to the interface. We would want to create a new branch from master named like this:

feature/exit-button

When we commit on that new branch we would like to have specific commit messages. For example, if we change the position position of the exit button to the top-right corner we would have this message:

"Moved button to top-right corner"

Issues

Resolve an Issue

• Never work directly on master branch
• Write the issue number into your commit message.