Project

General

Profile

Meeting #170

Define a template for the commit message

Added by André Neto over 9 years ago. Updated about 5 years ago.

Status:
Closed
Priority:
Normal
Assignee:
-
Target version:
-
Start date:
29.07.2015
Due date:
% Done:

0%

Estimated time:

Description

Define a template for the git commit messages.
Add this information to the wiki.


Related issues

related to Meeting #166: MARTe 2 Sprint report (v0.1)Closed13.05.201502.07.2015

History

#1 Updated by Ivan Herrero over 9 years ago

The tutorial https://www.atlassian.com/git/tutorials/saving-changes/git-commit gives an example of a canonical format for the commit's message.

"Git doesn't require commit messages to follow any specific formatting constraints, but the canonical format is to summarize the entire commit on the first line in less than 50 characters, leave a blank line, then a detailed explanation of what’s been changed. For example:

Change the message displayed by hello.py

- Update the sayHello() function to output the user's name
- Change the sayGoodbye() function to a friendlier message

Note that many developers also like to use present tense in their commit messages. This makes them read more like actions on the repository, which makes many of the history-rewriting operations more intuitive."

Note: The convention of summarize the entire commit on the first line (<50 chars) is very useful when viewing the log with the oneline option (git log --oneline).

Googling "git commit message convention" will propose more articles about this issue.

#2 Updated by Ivan Herrero over 9 years ago

  • Parent task deleted (#166)

#3 Updated by Ivan Herrero over 9 years ago

  • related to Meeting #166: MARTe 2 Sprint report (v0.1) added

#4 Updated by André Neto about 5 years ago

  • Status changed from New to Closed
  • Assignee deleted (Ivan Herrero)

Also available in: Atom PDF