Comment écrire un descriptif de modification

Quand vous contribuez du code au projet PrestaShop (en utilisant Github), nous vous demandons d'adhérer de manière stricte à la manière donc l'équipe de développement rédige ses descriptifs de modification. Ainsi, lorsque nous compilerons l'historique des modifications d'une version, votre message s'intégrera parfaitement avec ceux déjà en place.

Un descriptif de modification doit être rédigé en anglais, et suivre le format suivante :

[type] category : description

Type

Le type correspond à l'idée générale suivie par votre modification : corrigez-vous un bug ? Proposez-vous une amélioration ?

Type	Signification
[-]	Correction de bug.
[*]	Amélioration.
[+]	Nouvelle fonctionnalité.
[~]	Retrait d'une fonctionnalité.

Veuillez faire en sorte qu'une modification ne fasse qu'une chose à la fois. Si vous souhaitez à la fois corriger un bug et proposer une amélioration, vous devez soit faire référence à la modification la plus importante, soit faire deux modifications.

Category

La catégorie est la partie du projet à laquelle votre modification s'applique.

Catégorie	Signification
FO	Front-office (thème, contrôleur front, images, CSS, JavaScript, etc.).
BO	Back-office (thème, contrôleur admin, images, CSS, JavaScript, etc.).
Installer	Tous les fichiers du dossier /install.
TR	Les fichiers de traduction.
MO	Les modules. Veuillez préciser le nom du module dans le descriptif de modification.
Deprecated	Lorsque vous rendez du code obsolète. Veuillez préciser le nom de la classe et celui de la fonction.
Security	Résolution d'une faille de sécurité, par exemple une faille XSS.
Project	Une modification qui affecte le projet dans son ensemble.
PDF	Modification d'un modèle de PDF.
WS	Service web.
LO	Pack de localisation.

Description

Utiliser la description pour expliquer en quelques mots ce que fait votre modification.

Si vous corrigez un bug connu, veuillez préciser son numéro Forge dans la description (ex. : #PSCFV-007).

Exemple de descriptif de modification

Voici quelques descriptifs d'exemple :

[-] BO : fixed bug while updating images in AdminProduct[*] FO : you can now buy products without TVA[+] Modules : new module RSS Feed[~] Deprecated : Product::getReductionValue()

Nouveaux fichiers

Si vous ajoutez de nouveaux fichiers, ils doivent commencer par les sections "NOTICE OF LICENSE" et "DISCLAIMER".

Vous pouvez simplement copier ces sections depuis d'autres fichiers du projet, ou utiliser le bloc suivant :

<?php/** 2007-2013 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 [e-mail] 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 <[e-mail]>* @copyright 2007-2013 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*/