tommarshall / git-good-commit

Git hook to help you write good commit messages, with no external dependencies.
MIT License
193 stars 33 forks source link

Add support for Sem-Ver pseudo-headers inside commit messages #15

Open ssbarnea opened 7 years ago

ssbarnea commented 7 years ago

Sem-Ver is a way to add meta-data information about commit types that is growing more and more popularity.

A project using adopting Sem-Ver in comments, would be able to:

Mainly this is based on the concept that each commit should fix in one of these categories:

I was not able to find an official specification regarding recognized SemVer keywords (symbols) but so far this list seems to be supported by all implementations I found so far:

Please note sem-ver seems to allow multiple keywords separated by commands, which means that the verification should not enforce a specify syntax: it should raise an error only if it failed to match any known strings.

Few resources:

tommarshall commented 7 years ago

Hi @ssbarnea.

The existing hook appears to be compatible with all of the examples on http://autosemver.readthedocs.io/en/latest/usage.html

Can you give me an example of a Sem-Ver commit message that is incorrectly reporting warnings?

Tom

tommarshall commented 7 years ago

Hi @ssbarnea,

Are you able to provide some examples of Sem-Ver commit messages that reporting warnings?

Thanks, Tom