Closed detj closed 1 year ago
Mention in the documentation that after cloning, contributors need to run the following commands in order for local git hooks to work correctly.
npm install
npm run prepare
Addtionally, this also implies that contributors must have node
and npm
available and configured in their local environment.
Motivation
We use Conventional Commits for our commit hygiene.
Ensuring good commit message hygiene is not just a good to have kind of thing. It's essential for the project's long term tangible goals.
Having accurate, crisp, well formatted, well structured commit messages, allows us to:
Goals
What we are setting out to achieve in this area.
Execution
FAQs
Do external contributors need to follow ConventionalCommits specification?
While external contributors are free to follow ConventionalCommits specification if they wish to, this may not be strictly necessary. It depends on the contribution process. If the project is setup in a way that direct commits to default/protected branch is not allowed and PRs are squashed-merged, then lead maintainers always get a chance to reformat commit messages according to the project's needs.
References