Standard for Git commit messages - Revision history

C schmitz: /* The commit description */

2025-04-08T16:13:03Z

The commit description

← Older revision		Revision as of 18:13, 8 April 2025
Line 46:		Line 46:
	Following the commit type is the commit description. This must be a single line (no newline character), and is intended to be used in the generated changelog.		Following the commit type is the commit description. This must be a single line (no newline character), and is intended to be used in the generated changelog.

	Ideally it is a text readable by end-users. For instance, ''''if you're resolving a bug ticket give the commit a user-friendly description and make sure it describes the problem, not the solution''''. Remember that an end-user would scan the log that way for a fix for his/her specific problem.		Ideally it is a text readable by end-users. For instance, '''if you're resolving a bug ticket give the commit a user-friendly description and make sure it describes the problem, not the solution'''. Remember that an end-user would scan the log that way for a fix for his/her specific problem.

	==The development details==		==The development details==

C schmitz at 16:12, 8 April 2025

2025-04-08T16:12:38Z

← Older revision		Revision as of 18:12, 8 April 2025
Line 46:		Line 46:
	Following the commit type is the commit description. This must be a single line (no newline character), and is intended to be used in the generated changelog.		Following the commit type is the commit description. This must be a single line (no newline character), and is intended to be used in the generated changelog.

	Ideally it is a text readable by end-users~~: for~~ instance if you're resolving a bug ticket give the commit a user-friendly description and make sure it describes the problem, not the solution. Remember that an end-user would scan the log that way for a fix for his/her specific problem.		Ideally it is a text readable by end-users. For instance, ''''if you're resolving a bug ticket give the commit a user-friendly description and make sure it describes the problem, not the solution''''. Remember that an end-user would scan the log that way for a fix for his/her specific problem.

	==The development details==		==The development details==

Tibor.pacalat: corrected standard for security commit message

2023-07-26T14:28:39Z

corrected standard for security commit message

← Older revision		Revision as of 16:28, 26 July 2023
Line 38:		Line 38:
	==The commit label : security ==		==The commit label : security ==

	if commit is a security fix, add "[security]" label to first line commit description~~, just after commit type~~.		If commit is a security fix, add "[security]" label to first line commit description like in the example below.

	Example : <code>Fixed issue [security] ~~#1234:~~ Persistent XSS</code>		Example : <code>Fixed issue #1234: [security] Persistent XSS</code>

	==The commit description==		==The commit description==

C schmitz: Text replacement - " enclose="div"" to ""

2022-02-16T13:07:25Z

Text replacement - " enclose="div"" to ""

← Older revision		Revision as of 15:07, 16 February 2022
Line 14:		Line 14:
	** The following lines begin with the Keyword '''Dev''' and are intended to the developpers team		** The following lines begin with the Keyword '''Dev''' and are intended to the developpers team

	<syntaxhighlight lang="text~~" enclose="div~~"><Commit type>: <commit label> <commit description> <NEWLINE>		<syntaxhighlight lang="text"><Commit type>: <commit label> <commit description> <NEWLINE>

	[ Dev <development details> <NEWLINE> ]		[ Dev <development details> <NEWLINE> ]
Line 62:		Line 62:
	Example of a simple language file update:		Example of a simple language file update:

	<syntaxhighlight lang="text~~" enclose="div~~">Updated translation: German</syntaxhighlight>		<syntaxhighlight lang="text">Updated translation: German</syntaxhighlight>

	Example of a security fix:		Example of a security fix:

	<syntaxhighlight lang="text~~" enclose="div~~">Fixed issue #9762: [security] XSS possible</syntaxhighlight>		<syntaxhighlight lang="text">Fixed issue #9762: [security] XSS possible</syntaxhighlight>

	Example of a single bug which is fixed in several commits:		Example of a single bug which is fixed in several commits:
Line 72:		Line 72:
	Commit 1:		Commit 1:

	<syntaxhighlight lang="text~~" enclose="div~~">Fixed issue #2565: Can't access survey more than once on the same browser window		<syntaxhighlight lang="text">Fixed issue #2565: Can't access survey more than once on the same browser window

	Dev: This fixes this bug for survey with tokens.		Dev: This fixes this bug for survey with tokens.
Line 80:		Line 80:
	Commit 2:		Commit 2:

	<syntaxhighlight lang="text~~" enclose="div~~">		<syntaxhighlight lang="text">

	Fixed issue #2565: Can't access survey more than once on the same browser window		Fixed issue #2565: Can't access survey more than once on the same browser window
Line 90:		Line 90:
	Commit 3:		Commit 3:

	<syntaxhighlight lang="text~~" enclose="div~~">Fixed issue #2565: Can't access survey more than once on the same browser window		<syntaxhighlight lang="text">Fixed issue #2565: Can't access survey more than once on the same browser window

	Dev: This fixes this bug for survey without tokens and with answer preview.		Dev: This fixes this bug for survey without tokens and with answer preview.
Line 98:		Line 98:
	Example of a single commit containing several fixes each with a Dev comment:		Example of a single commit containing several fixes each with a Dev comment:

	<syntaxhighlight lang="text~~" enclose="div~~">Fixed issue #1234: Fixed some untranslated strings		<syntaxhighlight lang="text">Fixed issue #1234: Fixed some untranslated strings

	Dev: Missing call to clang-gT in admin.php		Dev: Missing call to clang-gT in admin.php

DenisChenu: /* The commit label */ example + only one label

2019-04-03T11:21:27Z

The commit label: example + only one label

← Older revision		Revision as of 13:21, 3 April 2019
Line 36:		Line 36:
	* If the commit is not connected to any tracker issue and not of public interest (changelog), just pure development then use ''''Dev''''		* If the commit is not connected to any tracker issue and not of public interest (changelog), just pure development then use ''''Dev''''

	==The commit label==		==The commit label : security ==

	if commit is a security fix, add "[security]" label to first line commit description, just after commit type.		if commit is a security fix, add "[security]" label to first line commit description, just after commit type.

			Example : <code>Fixed issue [security] #1234: Persistent XSS</code>

	==The commit description==		==The commit description==

C schmitz: /* The development details */

2016-03-01T08:07:11Z

The development details

← Older revision		Revision as of 10:07, 1 March 2016
Line 48:		Line 48:
	==The development details==		==The development details==

	Develoment details are added in extra ~~optionnal~~ lines, each one beginning with the keyword ''''Dev''''.		Develoment details are added in extra optional lines, each one beginning with the keyword ''''Dev''''.

	==Patches which require multiple commits==		==Patches which require multiple commits==

C schmitz: /* The commit description */ Provide a description of the problem fixed, not the solution

2016-03-01T08:06:56Z

The commit description: Provide a description of the problem fixed, not the solution

← Older revision		Revision as of 10:06, 1 March 2016
Line 42:		Line 42:
	==The commit description==		==The commit description==

	Following the commit type is the commit description.		Following the commit type is the commit description. This must be a single line (no newline character), and is intended to be used in the generated changelog.

	~~This must be a single line (no newline character), and is intended to be used in the generated changelog.~~		Ideally it is a text readable by end-users: for instance if you're resolving a bug ticket give the commit a user-friendly description and make sure it describes the problem, not the solution. Remember that an end-user would scan the log that way for a fix for his/her specific problem.

	Ideally it is a text readable by end-users: for instance if you're resolving a bug ticket ~~which has~~ a ~~very technical~~ description, ~~please use a "~~end-user ~~friendly description"~~.

	==The development details==		==The development details==

Aesteban: Add security label

2015-09-08T15:33:50Z

Add security label

← Older revision		Revision as of 17:33, 8 September 2015
Line 14:		Line 14:
	** The following lines begin with the Keyword '''Dev''' and are intended to the developpers team		** The following lines begin with the Keyword '''Dev''' and are intended to the developpers team

	<syntaxhighlight lang="text" enclose="div"><Commit type>: <commit description> <NEWLINE>		<syntaxhighlight lang="text" enclose="div"><Commit type>: <commit label> <commit description> <NEWLINE>

	[ Dev <development details> <NEWLINE> ]		[ Dev <development details> <NEWLINE> ]
Line 20:		Line 20:
	[ Dev <development details> <NEWLINE> ]		[ Dev <development details> <NEWLINE> ]

	<Commit type> <commit description> <NEWLINE>		<Commit type>: <commit label> <commit description> <NEWLINE>

	[ Dev <development details> <NEWLINE> ]		[ Dev <development details> <NEWLINE> ]
Line 35:		Line 35:
	* If the commit is about a new translation, the commit message must begin with the keyword ''''New translation''''		* If the commit is about a new translation, the commit message must begin with the keyword ''''New translation''''
	* If the commit is not connected to any tracker issue and not of public interest (changelog), just pure development then use ''''Dev''''		* If the commit is not connected to any tracker issue and not of public interest (changelog), just pure development then use ''''Dev''''

			==The commit label==

			if commit is a security fix, add "[security]" label to first line commit description, just after commit type.

	==The commit description==		==The commit description==
Line 59:		Line 63:

	<syntaxhighlight lang="text" enclose="div">Updated translation: German</syntaxhighlight>		<syntaxhighlight lang="text" enclose="div">Updated translation: German</syntaxhighlight>

			Example of a security fix:

			<syntaxhighlight lang="text" enclose="div">Fixed issue #9762: [security] XSS possible</syntaxhighlight>

	Example of a single bug which is fixed in several commits:		Example of a single bug which is fixed in several commits:

C schmitz: /* General overview */

2015-08-14T08:22:05Z

General overview

← Older revision		Revision as of 10:22, 14 August 2015
Line 3:		Line 3:
	=General overview=		=General overview=

	This page describes the standard format of commit messages. Indeed, standard commit messages will ~~ease~~ the automatic generation of releases change logs.		This page describes the standard format of commit messages. Indeed, standard commit messages will make sure that the automatic generation of releases change logs will work properly. '''If you do not follow these rules your contribution(s) might not be properly credited in the change log.
			'''

	=Rules=		=Rules=

C schmitz: /* The commit type */

2013-10-24T09:17:29Z

The commit type

← Older revision		Revision as of 11:17, 24 October 2013
Line 33:		Line 33:
	* If the commit is about a new feature, the commit message must begin with the keyword ''''New feature''''		* If the commit is about a new feature, the commit message must begin with the keyword ''''New feature''''
	* If the commit is about a new translation, the commit message must begin with the keyword ''''New translation''''		* If the commit is about a new translation, the commit message must begin with the keyword ''''New translation''''
			* If the commit is not connected to any tracker issue and not of public interest (changelog), just pure development then use ''''Dev''''

	==The commit description==		==The commit description==