Contribuer

Les règles suivantes ont pour but de conserver un code clair et accessible pour tout nouveau volontaire, et de ne pas rendre la lecture des révisions pénible.

Penser à configurer git pour que les commits soient clairement. Il suffit par exemple sous Linux des commandes suivantes, entrées dans le répertoire racine du projet.

git config user.name Joyeux Développeur
git config user.email developpeur@chezmoi.fr

Le français est utilisé partout . Que ce soit pour le rendu sur la page HTML, bien sûr, mais aussi pour le nom des classes, des variables, des fonctions… En revanche, pour ne pas s'exposer à des problèmes de locales, les signes diacritiques doivent être omis dans le code.

Le code suit des règles de style homogènes et PHP Coding Standards Fixer est installé par Composer afin que chacun puisse les vérifier avant d'envoyer une modification.

/vendor/bin/php-cs-fixer fix

Le code est structuré de manière à séparer les aspects et à facilité la recherche d'une fonction, d'un élément… Avant de créer une nouvelle fonction, il convient de cherche s'il n'en existe pas une assez proche qui soit généralisable sans nuire à sa lisibilité. Si un nouveau fichier doit être créé, son emplacement doit :

• correspondre à un chemin logique s'il s'agit d'une nouvelle page du site ;
• s'intégrer dans les répertoires décrits dans Guide de lecture s'il s'agit d'une nouvelle méthode d'accéder à la base de donnée, d'une fonctionnalité transverse ou d'un nouvel élément de bibliothèque ré-employable.