conventional-changelog/commitlint

Acronyms incorrectly detected as upper-case

Open

#3.312 geöffnet am 15. Aug. 2022

Auf GitHub ansehen
 (18 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (896 Forks)batch import
communitydiscussionhelp wanted

Repository-Metriken

Stars
 (15.497 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 5T 19h) (65 gemergte PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Untersuche die Implementierung der 'subject case' Regel in @commitlint/core, insbesondere wie die Großschreibungserkennung funktioniert. Ändere die Logik so, dass Wörter, bei denen alle Buchstaben großgeschrieben sind (Akronyme), übersprungen werden, es sei denn, das Wort besteht nur aus einem Buchstaben.
Tech Stack
typescriptnodejs
Domain
developer experiencetooling
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitNode.js
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65