...
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.
Commit messages The commit/PR title must be in English, and have to be formatted like this:
| Code Block |
|---|
[type] category : description |
You can put more details in the commit description.
Type
The type is the general idea behind your commit: are you fixing a bug, making an improvement, etc.?
...
Use the description to explain what your commit does in a few words. Try to be concise!
If you fixed a bugticket from the Forge, please specify the bug's Forge number in the description (eg: #PSCFV-007).
...
| Code Block |
|---|
<?php /** * 2007-20142015 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 [email protected] 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 protected]> * @copyright 2007-2014 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 */ |
...or for modules...
| Code Block |
|---|
/** * 2007-20142015 PrestaShop * * NOTICE OF LICENSE * * This source file is subject to the Academic Free License (AFL 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/afl-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 [email protected] 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 protected]> * @copyright 2007-2014 PrestaShop SA * @license http://opensource.org/licenses/afl-3.0.php Academic Free License (AFL 3.0) * International Registered Trademark & Property of PrestaShop SA */ |