Make first-time encounters easier for contributors #94
Description
First time contributors of projects using commitlint
run into our checks unprepared.
This increases friction at a point critical for every OSS project, up to the point where commit messages are lost:
- fix: read config file before defaulting script parameter remy/nodemon#1110 (comment)
- get rid of commitlint googleapis/cloud-trace-nodejs#543
- chore: backoff from using commitlint google/gts#8
- A plea to abolish commit hooks uPortal-Attic/uportal-app-framework#535
We should do more to make contributing as easy as possible when commitlint
is used
-
@commitlint/template
. Will prepend commit messages with example messages generated from our config. Idea snatched from fix: read config file before defaulting script parameter remy/nodemon#1110 (comment), example: lennym/commit-template. This introduces a secondhusky
commit hook, increasing install complexity. Decide ifcommitlint init
should set this when implemented: https://github.com/marionebl/commitlint/issues/48 -
commitlint restore
: Let users restore commit messages that failed the tests for repeated edits. Theoretically we could even create apreparecommitmsg
hook to read that from an agreed-upon place? -
commitlintbot: Support commitlintbot to become the go-to tool for projects opting for linting on PR/Squashing level only. This approach moves the burden of commit conventions to project maintainers entirely.