Child pages
  • How to write a commit message
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Commit messages must be in english, and have to be formated like this : [nature] type : content

- Nature :

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="88e34cf4-a681-4edc-84e8-c52ba6634cdd"><ac:plain-text-body><![CDATA[

[-]

bug fix

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="e32d5cb3-5ac6-4a09-8b9a-b6051310f2a2"><ac:plain-text-body><![CDATA[

[*]

improvement

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="0b27c22d-ad5c-41c0-b24b-f1bd37853b63"><ac:plain-text-body><![CDATA[

[+]

add feature

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="1793ab9a-f3a5-4c1d-bb2a-76ac46bcc122"><ac:plain-text-body><![CDATA[

[~]

when deprecated something

]]></ac:plain-text-body></ac:structured-macro>

- Type :

FO

front office (theme, front controller, images, css, js, ...)

BO

back office (theme, admin controller, images, css, js, ...)

Installer

all files in install folder

TR

translation files

MO

modules. specify the module name in content of commit message

Deprecated

when deprecated some code. specify the classe name and function

Security

security fix like XSS

Project

changes affecting the entire project

PDF

pdf template modifications

WS

Web Service

LO

Localization pack

              
- Contenu

Explain what did you commit in a few words.

If you fix a bug, please specify the bug number in the content (eg: #PSCFV-007)

Commit example :

[-] BO : fixed bug while updating images in AdminProduct
[*] FO : you can now buy products without TVA
[+] Modules : new module RSS Feed
[~] Deprecated : Product::getReductionValue()

- New files

If you add new files they need to have the "NOTICE OF LICENSE" and the "DISCLAIMER". You can copy/past from existing file in the project.

  • No labels