conventional-changelog/commitlint

Acronyms incorrectly detected as upper-case

Open

#3,312 opened on Aug 15, 2022

View on GitHub
 (18 comments) (0 reactions) (0 assignees)TypeScript (896 forks)batch import
communitydiscussionhelp wanted

Repository metrics

Stars
 (15,497 stars)
PR merge metrics
 (Avg merge 5d 19h) (65 merged PRs in 30d)

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

Contributor guide

Research direction
Investigate the 'subject case' rule implementation in @commitlint/core, specifically how uppercase detection works. Modify the logic to skip words where all letters are uppercase (acronyms) unless the word is a single letter.
Tech stack
typescriptnodejs
Domain
developer experiencetooling
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65