conventional-changelog/commitlint

feat: allow initial commit message

Open

#3,578 opened on 2023年4月6日

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

説明

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

コントリビューターガイド

feat: allow initial commit message · conventional-changelog/commitlint#3578 | Good First Issue