Deno: Add style guide for commit messages

Created on 8 Apr 2019  Â·  4Comments  Â·  Source: denoland/deno

Our commit message formatting is all over the place. Now that Deno is a bit more mature we should try to nail this down. Ideally we'd have some sort of lint for commit messages as well (for example, the first line of commit end in a period, CI should reject such messages)

https://golang.org/doc/contribute.html#commit_messages
https://github.com/golang/go/wiki/CommitMessage

Most helpful comment

If you’re mainly committing via PRs, I’d suggest instead linting PR titles using a GitHub App instead, since those are much easier to edit and the “squash and merge” feature pretty much obliterates the commit messages anyway. This could work hand-in-hand with requiring CI to pass before merging, effectively blocking commits from being pushed to master directly.

All 4 comments

Agreed. Also it would be nice to work on the style guide of Issues and PR using the github templates.

IMHO good for that are commitizen + commitlint.

If you’re mainly committing via PRs, I’d suggest instead linting PR titles using a GitHub App instead, since those are much easier to edit and the “squash and merge” feature pretty much obliterates the commit messages anyway. This could work hand-in-hand with requiring CI to pass before merging, effectively blocking commits from being pushed to master directly.

This has largely been done in the PULL_REQUEST_TEMPLATE.md, though docs/contributing/ could of course be more explicit, but closing for now.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

xueqingxiao picture xueqingxiao  Â·  3Comments

sh7dm picture sh7dm  Â·  3Comments

kitsonk picture kitsonk  Â·  3Comments

ry picture ry  Â·  3Comments

ry picture ry  Â·  3Comments