Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: ajoute une action commitlint #38

Merged
merged 2 commits into from
Dec 14, 2022
Merged

ci: ajoute une action commitlint #38

merged 2 commits into from
Dec 14, 2022

Conversation

slafayIGN
Copy link
Contributor

Je propose l'ajout d'une action commitlint à chaque push pour renforcer la cohérence des messages de commit.

Référence : https://www.conventionalcommits.org/en/v1.0.0/

Il reste à se mettre d'accord essentiellement sur les types de commits. J'ai copié la liste d'un autre projet open-source mais la liste me semble avoir des redondances ou des types dont nous n'avons pas l'usage :

  • feat : nouvelle fonctionnalité pour l'utilisateur (pas une nouvelle fonctionnalité dans un script de build)
  • fix : correction de buf pour l'utilisateur (pas de correction de bug dans un script de build)
  • docs : changements dans la documentation (docs, README, CONTRIBUTING...)
  • style : formatage, point-virgules ou accolades manquantes... sans autre changement fonctionnel
  • refactor : refactoring du code, renommages de classes, fonctions, variables...
  • test : ajout de tests manquants, refactoring des tests sans autre changement fonctionnel
  • chore : mise à jour de tâches npm, grunt... sans autre changement fonctionnel
  • ci : changements dans la configuration des github actions et workflows, pourrait être considéré comme chore
  • build : me semble redondant avec chore ou ci
  • config : configuration de l'application elle-même et pas des scripts de build
  • norelease : me semble inutile tant que semantic-versioning n'est pas branché derrière
  • breaking : me semble inutile tant que semantic-versioning n'est pas branché derrière, surtout que conventional commits propose plutôt d'utiliser la notation BREAKING_CHANGE en footer du message de commit

L'intérêt de commitlint serait de pouvoir brancher ensuite la publication automatique de releases et packages : https://github.com/semantic-release/semantic-release

@mborne
Copy link
Contributor

mborne commented Dec 13, 2022

@slafayIGN je suis partant pour qu'on essaye ce niveau de rigueur.

Par contre, preneur d'un lien "Contribuer" dans le README.md

@mborne mborne merged commit 95c14ba into master Dec 14, 2022
@mborne mborne deleted the commitlint branch December 14, 2022 07:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants