La contribution n’est pas seulement une question de code. En tant que projet open source, chacun est encouragé à participer à la construction de PrestaShop : vous pouvez traduire le logiciel dans votre langue maternelle, suggérer une nouvelle fonctionnalité, vous inscrire au Club Utilisateur et partager votre expérience avec les équipes produits, devenir un ambassadeur… et aussi écrire des spécifications !
Hébergées sur un dépôt GitHub dédié, les spécifications du produit ont pour but de décrire formellement comment les fonctionnalités doivent fonctionner sur une page donnée. A la différence des spécifications techniques (qui visent à décrire la mise en oeuvre interne des fonctionnalités), les spécifications produit expriment la portée fonctionnelle des pages de PrestaShop.
Par exemple, les spécifications de produit peuvent décrire l’action qui est effectuée lorsque l’on clique sur ce bouton, les caractères considérés comme non valables pour ce champ, la notification qui apparaît dans ce cas, etc. Voir l’exemple ci-dessous, relatif à la page du produit.
Spécifications de la page produit PrestaShop
:point_right : Lire les spécifications de la page produit IRL ici
Alors si vous, en tant qu’utilisateur passionné de PrestaShop, souhaitez partager votre expertise sur certaines fonctionnalités qui n’ont plus de secrets pour vous, unissons nos forces et écrivons ensemble les spécifications fonctionnelles du logiciel ! Ce n’est pas du code, c’est juste une écriture précise pour décrire comment les fonctionnalités sont censées se comporter.
Structure du répertoire
Plusieurs répertoires se trouvent dans le dépôt, parmi lesquels les quatre principaux dossiers suivants :
Le répertoire du back office, où toute page du back office (BO) doit être spécifiée, par exemple la page du produit ;
Le répertoire des sujets plus larges, où les caractéristiques ayant un impact important doivent être spécifiées, par exemple la stratégie de référencement dans l’ensemble du logiciel ;
Le répertoire du front office, où toute page du front office (FO) doit être spécifiée, par exemple les images des produits ;
Et le répertoire des modules, où tous les modules intégrés (« natifs ») doivent être spécifiés, par exemple le module de recherche à facettes.
Une page du back-office équivaut à une page de spécifications. Il est essentiel d’être exhaustif : toute fonctionnalité qui ne fonctionne pas comme décrit dans les spécifications est considérée comme un bogue ! La rédaction des spécifications est essentielle pour s’assurer que les fonctionnalités fonctionnent comme prévu sur la dernière version stable disponible de PrestaShop.
Actuellement, de nombreuses fonctionnalités n’ont pas été formellement spécifiées mais, mieux vaut tard que jamais, nous nous efforçons de spécifier toute nouvelle fonctionnalité ou tout changement avant que le système ne soit modifié. Cela permet d’obtenir des développements pertinents mais aussi de limiter la dette fonctionnelle du logiciel en conservant un historique des décisions prises jusqu’à présent.
Flux de travail
Comme indiqué ci-dessus, les spécifications sont essentielles au développement car elles décrivent le comportement attendu du système pour une fonctionnalité donnée. Ainsi, lorsque les développeurs travaillent sur le code de PrestaShop, ils traduisent en fait ces spécifications fonctionnelles en code. Chaque développement effectué doit être lié à la spécification correspondante.
Vous pouvez soit améliorer les spécifications existantes, soit ajouter des spécifications manquantes, soit même spécifier de nouvelles fonctionnalités.
Améliorer les spécifications existantes
Avez-vous remarqué des éléments manquants à la lecture d’une page de spécifications ? Eh bien, je suppose qu’il est temps de la compléter ! Il peut s’agir de corrections mineures telles que la correction de fautes de frappe, l’amélioration d’une syntaxe peu claire, l’ajout de captures d’écran, etc. S’il s’agit d’un comportement manquant, vous devriez lire le paragraphe suivant. ??
Ajouter les spécifications manquantes
De nombreuses caractéristiques existantes n’ont pas encore été formellement spécifiées, il reste donc beaucoup à faire. L’ajout des spécifications manquantes sur le comportement actuel permettra de fournir à l’écosystème PrestaShop une vue précise de la portée fonctionnelle du logiciel.
Spécifier de nouvelles fonctionnalités
Lorsqu’une nouvelle fonctionnalité est proposée ou prévue, il est essentiel de définir sa portée et donc de préciser son utilisation car elle guidera ses développements.
Mode d’emploi
Concentrons-nous maintenant sur l’aspect pratique ! Pour commencer, vous avez deux choix : soit la page existe déjà dans le référentiel des spécifications et il vous suffit de la modifier pour la compléter, soit elle n’existe pas encore et vous devrez la créer pour proposer vos spécifications.
Qu’il s’agisse d’une édition ou d’un ajout, il faudra créer une demande de retrait (PR) – comme pour tout développement ! Vous en apprendrez plus sur les étapes détaillées dans le fichier CONTRIBUTING.md ici et sur le modèle suggéré à utiliser dans la prochaine section de ce billet.