How to write a commit message
When you contribute code to the PrestaShop project (through Github), we ask that you strictly use the PrestaShop way of writing a commit/PR message. This way, when building the code history, your commit message will fit nicely with the ones from the PrestaShop developers.
The commit/PR title must be in English, and have to be formatted like this:
You can put more details in the commit description.
The type is the general idea behind your commit: are you fixing a bug, making an improvement, etc.?
Please make sure that one commit does only one thing. If you made both fixes and improvement in the code, either use the most important change in the commit message, or make two commits.
The category is the portion of the project to which your changes apply to.
|CORE||The core of the software itself: classes, controllers, etc.|
All the files in the
The translation files.
Modules. Please specify the module's name in the content of commit message.
When deprecating some code. Please specify the class name and its function name.
Security fixes, such as XSS fixes.
Changes affecting the entire project.
PDF template modifications.
|TEST||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 specify the bug's Forge number in the description (eg: #PSCFV-007).
Sample commit message
Here are a few sample messages:
If you add new files, they need to have the "NOTICE OF LICENSE" and the "DISCLAIMER" sections at the start of the file.
- For general PrestaShop files: the notice should mention the OSL 3.0 license.
- For module files: the notice should mention the AFL 3.0 license.
You can copy/paste from existing files in the project.
You can also use this for general files:
...or for modules...