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.

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

[RFC] How about using "commitlint" for new contributors? #1969

Open
gichoel opened this issue Sep 9, 2024 · 3 comments
Open

[RFC] How about using "commitlint" for new contributors? #1969

gichoel opened this issue Sep 9, 2024 · 3 comments

Comments

@gichoel
Copy link
Contributor

gichoel commented Sep 9, 2024

We ask new contributors to follow the rules for writing commit messages, but there is nothing in CONTRIBUTING.md about commit messages.

Because there are no explicit rules for writing commits, we believe that contributors who are familiar with CONTRIBUTING.md rules from other open source projects may be confused when they first want to contribute to uftrace.

Therefore, we propose to explicitly mention in CONTRIBUTING.md the rules to follow when writing commit messages, as in several other open source projects [1, 2], and to use commitlint as mentioned in a previous PR Comment: #1810 (comment).

[1]. https://github.com/rapid7/metasploit-framework/blob/master/CONTRIBUTING.md#pull-requests
[2]. https://github.com/openbmc/docs/blob/master/CONTRIBUTING.md#formatting-commit-messages

@honggyukim
Copy link
Collaborator

Thanks for the heads up @gichoel! I think having the commit message guide in CONTRIBUTING.md will be helpful. And having commitlint as a pre-commit hook will also be very useful as well.

@gichoel
Copy link
Contributor Author

gichoel commented Sep 10, 2024

Thanks for the advice @honggyukim. :)

I'll work on a PR about updating CONTRIBUTING.md and applying commitlint soon and upload it

@honggyukim
Copy link
Collaborator

Thanks @gichoel! Please go head. It'd be really helpful for us!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants