conventional-changelog/commitlint

Acronyms incorrectly detected as upper-case

Open

#3 312 ouverte le 15 août 2022

Voir sur GitHub
 (18 commentaires) (0 réactions) (0 assignés)TypeScript (896 forks)batch import
communitydiscussionhelp 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

Faulty Behavior

fix: JTD types -> JSON schema types

✖   subject must not be sentence-case, start-case, pascal-case, upper-case [subject-case]

The above fails as the linter detects the subject as being upper-case, even though it's just an acronym.

Affected packages

  • cli
  • core
  • prompt
  • config-angular

Possible Solution

Check that all letters in the word are uppercase and assume it's an acronym, ignoring any title-case lints. Skip for 1 letter words.

Steps to Reproduce (for bugs)

Lint the above commit message with @commitlint/config-conventional.

Your Environment

Executable Version
commitlint --version 17.0.3
git --version 2.34.1
node --version 16.15.1
@commitlint/config-conventional 17.0.3

Guide contributeur

Direction de recherche
Examinez l'implémentation de la règle 'subject case' dans @commitlint/core, en particulier comment fonctionne la détection des majuscules. Modifiez la logique pour ignorer les mots dont toutes les lettres sont en majuscules (acronymes), sauf si le mot est une seule lettre.
Stack technique
typescriptnodejs
Domaine
developer experiencetooling
Type d'issue
Bug
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.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitNode.js
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65