How to Write a Git Commit Message

Timofey · December 16, 2019, 5:03am

Hi everyone. I want to share with you the great article that explains the best practices of how we should write our commit messages.

I have been practising this and hope that it will be really useful for us in the VC platform https://chris.beams.io/posts/git-commit/ (Show original in GitHub)

YanBrovkin · December 24, 2019, 9:37am

Hi! Just a suggestion: it would be great to mark in commit message (and in name of course) about what kind of changes provided in, e.g. Fix: wrong paths, Chore: some changes before merge w/master. In my practice, it could be very useful when searching in commit history. Also, in case commit related to some issue or task in task tracking system, would be better to mark it also

Timofey · December 24, 2019, 9:55am

Sure. It’s good and valid suggestion

mvktsk · December 31, 2019, 1:39am

You can find Commit Massage examples in our repository

OlegoO · March 6, 2020, 11:44am

Added Git commit message writing convention

github.com

VirtoCommerce/styleguide/blob/master/gitcommits.md

# Git commit message writing convention

These guideline are based on [How to Write a Git Commit Message](https://github.com/cbeams/chris.beams.io/blob/master/_posts/2014-08-31-git-commit.md) article.

## Commit message structure

Commit message should have following structure:

```markdown
JIRA-ID:Commit message subject line

Commit message body.
```

## Commit message rules

1. [Start Commit message subject line from Jira issue key (GitHub issue ID)](#1-commit-message-subject-line-should-start-from-jira-issue-key)
2. [Separate Jira issue key and Commit message subject line by a colon and blank](#2-separate-jira-issue-key-and-commit-message-subject-line-by-a-colon-and-blank)
3. [Write Jira issue key in uppercase](#3-write-jira-issue-key-in-uppercase)
4. [Separate subject from body with a blank line](#4-separate-subject-from-body-with-a-blank-line)

This file has been truncated. show original

Topic		Replies	Views
Webhook Payload Event Name - Order Has Been Changed Issue bug platform-v3	2	215	September 9, 2022
We should use 'dependabot' for our solution! dev	5	568	December 6, 2019
Issues with variations bug	1	648	February 13, 2020
About the bug category bug	0	523	October 7, 2019
What does $(Platform) mean? dev	1	232	March 3, 2022

How to Write a Git Commit Message

Related Topics