Skip to content

Naming Standards to use when working with GIT

Naming Branches

As a developer when you start developing a customer solution you must create a personal branch to commit your work. The following branching naming standards are recommended.

Type of Work Branch naming standard - build place Branch naming standard - release studio
Report Change topic/<user-id>/R-<issue-id>-<description> topic-ru/<user-id>/R-<issue-id>-<description>
Modification topic/<user-id>/M-<issue-id>-<description> topic-ru/<user-id>/M-<issue-id>-<description>
Service UPD Merge topic/<user-id>/SU-<issue-id>-<description, UPD version> topic-ru/<user-id>/SU-<issue-id>-<description, UPD version>
Bug Fix topic/<user-id>/B-<issue-id>-<description> topic-ru/<user-id>/B-<issue-id>-<description>
Release Update Merge Not applicable topic-ru/<user-id>/RU-<issue-id>-<description, release update version>

Best Practices when creating a topic branch

  • Note that "topic/" or "topic-ru/" is mandatory to be used when creating a topic branch, as this will be used to identify a branch as a valid topic branch within the LE portal.
  • Use a user ID/user's name in the topic branch to identify the person who created the branch.
  • Use an issue ID to uniquely identify a branch and to easily troubleshoot issues.
  • Use a meaningful description in the topic branch name to easily identify the changes done through the topic branch.
  • Make sure not to include keywords "master" and "release-update" in the branch name

Committing changes

The following standards must be followed when committing your branch into the 'master' branch or 'release-update' branch of the repository

Type of Work Commit message naming standard
Report Change R-<issue-id>-<description>
Modification M-<issue-id>-<description>
Bug Fix B-<issue-id>-<description>
Service UPD Merge SU-<issue-id>-<description, UPD version>
Release Update Merge RU-<issue-id>-<description, release update version>

Note: The issue-id mentioned above will be the issue-id of the underlying issue reported in your worktracking system, such as Jira or a similar tool.