Règles de contribution
Principes
Afin de permettre une bonne compréhension des développements et une maintenance facile, nous utilisons la gestion sémantique de version, à la fois pour le thème et pour l’admin.
Fonctionnements
Contributions
Pour signaler un problème ou un souhait de fonctionnalité, créer une issue.
Les étapes pour contribuer sont :
- Créer une branche nommée en fonction de ce qu’on fait, le plus simplement possible (en anglais, car les noms de branches n’ont ni espaces ni accents). De plus, elle ne doit pas porter le nom d’un fichier ou répertoire présent à la racine.
- Commit en mettant un message simple (pas de règles de syntaxe)
- Faire une Pull Request (PR) avec un nom simple en français et ajouter une description claire, avec une référence aux éventuelles issues traitées (avec close ou fix si c’est le cas)
- Demander la review
- Faire les modifs demandées par les reviewers
- Quand la PR est approuvée, la fusionner (merge) pour qu’elle parte en production automatiquement
La contribution directement dans main est bloquée.
En revanche, les personnes de l’équipe admin peuvent auto-valider une PR, et doivent le faire uniquement pour les bugfix.
Versions
L’équipe cœur crée des releases directement sur Github, avec le système de génération automatique de changelog.
Analyse de pratiques
Github
La documentation explique comment générer des releases, et comment utiliser la génération automatique de descriptions. Cela donne ça pour la v1.1.0.
Hugo
Hugo est versionné en v0.107.0, en suivant ce guide de contribution.
Le système utilisé est développé maison, et s’appelle hugoreleaser.
- https://github.com/gohugoio/hugo/blob/master/hugoreleaser.env
- https://github.com/gohugoio/hugo/blob/master/hugoreleaser.toml
Ruby on Rails
Rails est versionné en v7.0.4, en suivant ce guide de contribution.
Rails est une gem, et utilise donc le système de release intégré aux gems.
Les Pull Requests sont très petites, avec souvent 1 seul commit.
Devise
Idem Rails.