conventional-changelog/commitlint

Custom error message if commit format is wrong.

Open

#3 165 ouverte le 9 mai 2022

Voir sur GitHub
 (10 commentaires) (1 réaction) (0 assignés)TypeScript (896 forks)batch import
featurehelp wanted

Métriques du dépôt

Stars
 (15 497 stars)
Métriques de merge PR
 (Merge moyen 5j 19h) (65 PRs mergées en 30 j)

Description

The idea is pretty simple. If someone commits the first time to a new repo with commitlint the most common error is that the commitmsg was wrong. In our case we have a npm run commit that triggers the cz-cli. So I would like to add a custom error message for this case that the programmer can use npm commit. Thanks!

Guide contributeur

Direction de recherche
Examinez le code source de commitlint pour trouver où les erreurs de format de commit sont actuellement traitées. Regardez la logique de sortie d'erreur et réfléchissez à comment ajouter un message personnalisé suggérant d'utiliser 'npm run commit' si le format de commit est incorrect. Vérifiez les commentaires de l'issue pour des indices d'implémentation. Des fichiers comme 'cli.js' ou 'lint.js' pourraient être pertinents.
Stack technique
typescriptnodejs
Domaine
clitooling
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
basic Node.jsunderstanding of commitlint
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75