Directives de contribution

Tout d’abord, merci d’envisager de contribuer à ce projet !

Il s’agit principalement de lignes directrices, et non de règles. Faites preuve de discernement, et n’hésitez pas à proposer des modifications à ce document dans une pull request.

Git hooks

Nous utilisons les git hooks via pre-commit pour appliquer et vérifier automatiquement certaines “règles”. Veuillez l’installer avant de pousser un commit.

Voir le fichier de configuration correspondant : .pre-commit-config.yaml.

Style de code

Assurez-vous que votre code suit à peu près la PEP-8 PEP-8 et reste cohérent avec le reste du code :

  • docstrings: google-style est utilisé pour écrire la documentation technique.

  • formatage: black est utilisé pour formater automatiquement le code sans débat.

  • tri des imports: isort est utilisé pour trier les imports.

  • analyse statique: flake8 est utilisé pour identifier les écarts vis à vis de PEP-8 et maintenir un code source de qualité.

Branches

Le modèle est : {category}/{slugified-description}. Où :

  • category est le type de travail. Il peut s’agir de : feature, bug, tooling, refactor, test, chore, release, hotfix, docs, ci, deploy ou release-candidate.

  • slugified-description est la description du travail, sous forme de slug.

Exemple : feature/authentication-logic

Branches spéciales

  • main: la branche principale.