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 message. This way, when building the code history, your commit message will fit nicely with the ones from the PrestaShop developers.
Commit messages must be in English, and have to be formatted like this:
[type] category : 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.
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.
Use the description to explain what your commit does in a few words.
If you fixed a bug, please specify the bug's Forge number in the description (eg: #PSCFV-007).
Sample commit message
Here are a few sample messages:
[-] BO : fixed bug while updating images in AdminProduct [*] FO : you can now buy products without TVA [+] Modules : new module RSS Feed [~] Deprecated : Product::getReductionValue()
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, or use this:
<?php /* * 2007-2012 PrestaShop * * NOTICE OF LICENSE * * This source file is subject to the Open Software License (OSL 3.0) * that is bundled with this package in the file LICENSE.txt. * It is also available through the world-wide-web at this URL: * http://opensource.org/licenses/osl-3.0.php * If you did not receive a copy of the license and are unable to * obtain it through the world-wide-web, please send an email * to firstname.lastname@example.org so we can send you a copy immediately. * * DISCLAIMER * * Do not edit or add to this file if you wish to upgrade PrestaShop to newer * versions in the future. If you wish to customize PrestaShop for your * needs please refer to http://www.prestashop.com for more information. * * @author PrestaShop SA <email@example.com> * @copyright 2007-2012 PrestaShop SA * @version Release: $Revision: 6844 $ * @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0) * International Registered Trademark & Property of PrestaShop SA */