-
Notifications
You must be signed in to change notification settings - Fork 0
Commit message guid
Oleksandra korel Kalinina edited this page Sep 19, 2019
·
1 revision
To have commit story easy to understand, informative and trace commit with related Jira issue the following commit message pattern is used.
[issue-type]([JIRA-ticket-number]): [keywords] [jira-smart-commit-command]
-
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
-
DS
- project code. -
###
- numeric, related ticket number in JIRA.
Short explanation of the task for your сolleagues.
To automate routine work such as Jira issue workflow transition or adding a comment, all team members need to use Jira smart commit syntax. NOTE: Please make sure that GitHub commit is signed with the email address you have signed in Jira.
Adds a comment to a JIRA Software issue.
Syntax:
<ignored text> ISSUE_KEY <ignored text> #comment <comment_string>
Example:
JRA-34 #comment corrected indent
Transitions a JIRA Software issue to a particular workflow state.
Syntax:
<ignored text> ISSUE_KEY <ignored text> #<transition-name> <comment_string>
Example:
JRA-090 #close Fixed this today