How to write a commit message
Last updated
Was this helpful?
Last updated
Was this helpful?
When you contribute code to the PrestaShop project (), we ask that you strictly use the PrestaShop way of writing a commit name. This way, when building the code history, your commit message will fit nicely with the ones from others contributors and from the PrestaShop developers.
The conventions were changed , and are now much simpler.
How to write a commit message
The commit's name must be in English, and should be formatted like this:
The title of the pull request should simply describe its content (whether it contains one or several commits), in the clearest way possible. The title should reflect the overall change of the pull request.
The category is the portion of the project to which your changes apply to.
Category
Meaning
FO
Front office (theme, front controller, images, CSS, JavaScript, module's FO, PDF, etc.).
BO
Back office (theme, admin controller, images, CSS, JavaScript, module's BO, etc.).
CO
The core of the software itself: classes, controllers, etc.
IN
All the files in the /install folder.
WS
Web Service.
LO
Localization pack.
TE
Unit tests or functional test.
Use the description to explain what your commit does in a few words. Try to be concise!
If you fixed a ticket from the Forge, please add a link to that ticket in the first comment and specify the bug's Forge number in the description (eg: #PSCFV-007).
You can put more details in the commit description.
Here are a few sample messages:
By submitting your code to the PrestaShop project, you are releasing it under a Open Source license: either OSL or AFL.
If you add new files, they need to have the "NOTICE OF LICENSE" and the "DISCLAIMER" sections at the start of the file.
You can copy/paste from existing files in the project.
You can also use this for general files:
...or for modules...
If your code change requires a lot of explanation, please explaining your intent with this code change, so that the Product team can discuss it with you. Once the ticket is created, link to it from the PR's comment, and give a link to the PR from the ticket, in order to bridge the two.
For general PrestaShop files: the notice should mention the .
For module files: the notice should mention the .