search

namhyung / uftrace

Function graph tracer for C/C++/Rust/Python
https://uftrace.github.io/slide/
GNU General Public License v2.0
3.08k stars 479 forks source link

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

Open gichoel opened 2 months ago

gichoel commented 2 months ago

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: https://github.com/namhyung/uftrace/pull/1810#issuecomment-1726659315.

[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 commented 2 months ago

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 commented 2 months ago

Thanks for the advice @honggyukim. :)

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

honggyukim commented 2 months ago

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