Skip to content

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

@gichoel

Description

@gichoel

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions