Branch name guide - Gapminder/dollar-street-framework GitHub Wiki

In order to have an easy and evident way to find a specifyc branch all team members should use the following pattern:

[issue-type]-[project-part]-[project]-[JIRA-ticket-number]-[keywords].

Possible values:

[issue-type]:

  • feat - new functionality of app
  • fix - fix of existing functionality
  • chore - routine task for productivity improvement such as refactoring, doc creation, deploy update, which is not linked to the actual feature

[project-part]:

  • server - for server part of app.
  • client - for front part of app.
  • DB - for DB update and task related to DB
  • CI - for task related to CI and automatic deploy
  • e2e - for e2e tests related tasks
  • API - for API tests related tasks
  • test - for Unit tests related tasks

[project]:

  • pages - for Dollar Street pages project
  • cms - for Dollar Street CMS.

[JIRA-ticket-number]:

  • DS - project code.
  • ### - numeric, related ticket number in JIRA.

[keywords]

Short explanation of task.

Examples:

feat-client-pages-DS-1000-add-video-autoplay

fix-server-pages-DS-1001-update-error-response-code

chor-server-cms-DS-1002-things-controller-refactoring