Skip to content

feat: add commit message lint to workflow #243

@Xunzhuo

Description

@Xunzhuo

What would you like to be added:

New workflow to check commit message standard

Why is this needed:

In the layotto commit history, we can see the commit message without any standard and it is hard to read. As projects grow up, there will be more and more commits with messages, if we don not any commit lint, it will be a trouble to check and review history commits.

Advantages:

  • 提供更多的历史信息,方便快速浏览。
  • 可以过滤某些commit(比如文档改动),便于快速查找信息
  • 可以直接从commit生成Change log。
  • 可读性好,清晰,不必深入看代码即可了解当前commit的作用。
  • 为 Code Reviewing做准备
  • 方便跟踪工程历史
  • 提高项目的整体质量,提高个人工程素质

Demo

demo

Commit Message Format
Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Details: https://github.com/conventional-changelog/commitlint

Metadata

Metadata

Assignees

Labels

help wantedExtra attention is needed

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions