This document contains guidelines how to specify commit comments and merge request (MR) title and description. Please check out /wiki/spaces/CMD/pages/5432398970 on how name a Git branch.
Gitlab can be found at https://gitlab.com/

Commits

Every commit must contain the Jira task Id, it's full task name, URL to the Jira task and optionally a short description about this commit (in that order).
The reason for this structure is to be able to quickly grasp what task this commit is about and what has changed in this commit.

Example:  

• Line 1: PSDEV-133: Moran - Dev/QA - Remove Feedback Scores
• Line 2: https://marinelsrippleops.atlassian.net/browse/PSDEV-133
• Line 3+: (some notes about changes in this commit) 

...

• Every feature/bug needs a merge request in Gitlab
• Merge request title: [Jira Task Id]: [Jira Task Title] (e.g. PSDEV-300: CSMART Scheduler - Sorting Problem Exists in Allocation Report)
  • If you have multiple tasks in one merge request, add all Jira Task Ids to the title so they get properly linked (i.e. SUCO-401/SUCO-354: CUK - Org Profile Field Updates)
  • If you want to prevent accidental merging add the prefix Draft in front of the title. It can't be merged until Draft is removed.
• Merge request description: 

  • Line 1: URL to Jira task (i.e. https://marinelsrippleops.atlassian.net/browse/PSDEV-300)

  • Line 2+ any details you deem important to record

...