Add commit-convention.md

[mbokinala]

Currently, when attempting to commit with a message that does not follow the proper format enforced by scripts/verifyCommit.ts, the following error message is shown:

 ERROR  invalid commit message format.

  Proper commit message format is required for automated changelog generation. Examples:

    feat: add 'comments' option
    fix: handle events on blur (close #28)

  See .github/commit-convention.md for more details.

However, the file .github/commit-convention.md does not exist, so contributors must track down the verifyCommit script by looking at package.json to find the format/types for commit messages (like feat, fix, docs, dx, refactor, perf, test, etc).

An alternative to adding the file would be to describe the proper commit message convention in the error message itself and provide all the various options for the 'type' of the commit (feat, fix, etc). All the allowed types can be found in /scripts/verifyCommit.ts

[github-actions]

Hello @mbokinala. We like your proposal/feedback and would appreciate a contribution via a Pull Request by you or another community member. We thank you in advance for your contribution and are looking forward to reviewing it!

[Shinigami92]

We took the script from Vite.
Thanks for the hint 🙂
Are you willing to open a PR for this?

PS: I'm a core team member of Vite 😉 You are allowed to copy the file over.

[mbokinala]

Sure, will do