Commit message guidelines - pesto-students/batch-10-tripen GitHub Wiki

We are following the Webhint Commit guidelines for this project. Commit messages should have the following structure:

<tag>: lowercased, summary (50 chars recommended)

If necessary, more detailed explanatory text and/or what this commit
fixes, wrapped to about 72 characters or so. The commit message should
be in the imperative: "Fix bug" and not "Fixed bug" or "Fixes bug."

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

fix #<issue>

The first line of the commit message (the summary) constitutes the one-sentence description of the change. It must be 50 characters in length or shorter, and should start with a that is one of the following:

breaking - for a backwards-incompatible changes.
build - changes to build process only.
test - adding tests
refac - for refactoring (anything that isn’t user-facing).
docs - changes to documentation only.
fix - for a bug fix.
feat - implemented a new feature.
update - for a dependency upgrade.
Here are some good commit message summary examples:

docs: fix broken links in `pull-requests.md`

feat: add hint to check life-work balance

build: generate new Travis CI token

The second line should be left blank if there are other lines after it.

All other lines, where possible, should be wrapped to about 72 characters.

If applicable, to refer to an issue, comment or URL not being resolved by the commit or to link to more related information, use ‘Ref ‘ below the seperator(——-) and before ‘Fix #‘. For example: Ref #1911, Ref https://github.com/webhintio/hint/pull/1911#issuecomment-463715363 or Ref https://webhint.io/docs/contributor-guide.

Note: The commit message structure is very important as we use the messages in our automatic release process (determining the new version number, updating the changelog, etc.).