Skip to content

Branches And Commit Messages

Base Branches

We are basing pull requests off the following branches:

  • master
  • develop

The master branch

This is the main branch, which is (currently) used for production deployments.

The develop branch

This is the main development branch, which is used for development deployments.

Feature Branches

When developing a feature one must:

  1. Have raised a ticket for the feature that is being worked on
  2. Create a dedicated feature branch for the same issue.

Please use the following convention for naming the branch:

issue/${issue-number}/${issue-description}

For example, if your ticket number is 1234 and it is about logging, then the branch name should be something like the following:

issue/1/add-logging

Feature branches for issues raised in other repositories should use the following naming convention:

kinsend/${repositoryName}/issue/${issue-number}/${issue-description}

Commit Message Style

Commits should be made using the following style:

kinsend/${repositoryName}#${issue-number}: Add logging

* Fixed A.
* Fixed B.

For example:

kinsend/kinsend-be#123: Add logging

* Set up logging.
* Added more detailed logging to the `doSomething` method.

This will then backlink the commit to the issue in the Github repository and will be easier to track.

If the fix covers several issues, you can use the following style:

kinsend/${repositoryName}#${issue-number}: Add logging
kinsend/${otherRepositoryName}#${other-issue-number}: Add detailed logging for the `doSomething` method

* Set up logging.
* Added more detailed logging to the `doSomething` method.

In case all commits are related to tickets within the same repository, then you may use #123: Add Logging instead:

#123: Add logging

* Set up logging.
* Added more detailed logging to the `doSomething` method.

#234: Fixed another task.

* Did something important here.

This approach to commit messages allows easier navigation and most importantly a fast way to revert commits related to a new feature in case of disaster.