conventional-changelog/commitlint

feat: allow initial commit message

Open

#3578 opened on Apr 6, 2023

View on GitHub
 (1 comment) (7 reactions) (0 assignees)TypeScript (15,497 stars) (896 forks)batch import
discussionfeaturehelp wanted

Description

Expected Behavior

When creating a new repository, almost all Git tools, in their default configurations, initialize it with a single commit containing the Initial commit message. This is the only exception that doesn't follow the strict conventional commits guidelines.

Current Behavior

When using the commitlint tool (standard configuration) in conjunction with Git Hooks, it checks every commit message to see if it is in the correct conventional commit format. When initializing a new repository manually, the first commit with the message "Initial commit" will fail:

⧗   input: Initial commit
✖   subject may not be empty [subject-empty]
✖   type may not be empty [type-empty]

✖   found 2 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

Affected packages

  • cli
  • core
  • prompt
  • config-angular

Possible Solution

Since Initial commit is the best practice, also in combination with Conventional Commits, I highly suggest updating the default configuration to allow this commit message.

Context

No response

Contributor guide

Tech stack
typescriptnodejs
Domain
clideveloper experience
Issue type
feature
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Node.jscommitlint configuration
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue requests allowing the 'Initial commit' message in commitlint's default configuration. Start by examining the default rules in the `@commitlint/config conventional` package, specifically where the subject empty and type empty rules are enforced. Look for existing code that handles exceptions or custom messages. Consider adding a configuration option such as 'allowInitialCommit' or modifying the parser to exempt that specific pattern. After implementing, test with a local git repository to ensure the change works as expected.