Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: add commit message lint to workflow #243

Closed
Xunzhuo opened this issue Oct 2, 2021 · 5 comments · Fixed by #244 or #440
Closed

feat: add commit message lint to workflow #243

Xunzhuo opened this issue Oct 2, 2021 · 5 comments · Fixed by #244 or #440
Assignees
@ZLBer
Labels
help wanted Extra attention is needed

Comments

@Xunzhuo
Copy link
Member

Xunzhuo commented Oct 2, 2021 •
edited
Loading

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
@Xunzhuo Xunzhuo mentioned this issue Oct 2, 2021
Merged
@nobodyiam
Copy link
Member

good point

@seeflood
Copy link
Member

Good point!
But checking every commit message is too strict . I think we can add PR title lint to workflow so that the commit history will be more readable
image

@seeflood seeflood reopened this Oct 21, 2021
@seeflood seeflood added the help wanted Extra attention is needed label Oct 21, 2021
@seeflood seeflood mentioned this issue Oct 21, 2021
Open
@ZLBer
Copy link
Member

ZLBer commented Mar 23, 2022

@seeflood do we need pr title check now? find an action, i have tested it, we can add.
https://github.com/thehanimo/pr-title-checker

@wangxingyu000 wangxingyu000 mentioned this issue Mar 23, 2022
Closed
20 tasks
@seeflood
Copy link
Member

seeflood commented Mar 23, 2022 •
edited
Loading

@ZLBer It sounds good ! I think we need it.
We can add some guideline on "how to format the PR title and pass the PR title check" in the document.
When users have trouble fixing the CI ,we can send them the document link and help them.

Should I assign it to you? @ZLBer

@ZLBer
Copy link
Member

ZLBer commented Mar 23, 2022

@seeflood fine, late commit

@ZLBer ZLBer mentioned this issue Mar 23, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ZLBer ZLBer

Labels
help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore(workflow): add commit lint workflow
ci: Pr title check ZLBer/layotto
4 participants
@nobodyiam @ZLBer @seeflood @Xunzhuo