...
When you contribute code to the PrestaShop project (through Github), 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.
These conventions also apply to pull request titles – unless your pull request contains several atomic commits, in which case we ask you to use a PR title which gives a good idea of what all the commits do.
| Note |
|---|
The conventions were changed on May 5th, 2016, and are now much simpler. |
...
The title of the pull request should be the same as its commit, and must follow the same convention.If the pull request has several commits, the title of the pull request should either use the name of the most important commit, or 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.
...
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 |
MO | Modules. Please specify the module's name in the content of commit message. |
PDF template modifications. | |
WS | Web Service. |
LO | Localization pack. |
| TE | Unit tests or functional test. |
...
| Code Block |
|---|
<?php /** * 2007-20162017 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-2016 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-20162017 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-2016 PrestaShop SA * @license http://opensource.org/licenses/afl-3.0.php Academic Free License (AFL 3.0) * International Registered Trademark & Property of PrestaShop SA */ |