chore: add commitlint and husky

[OlivierAlbertini]

Resolves #117

Signed-off-by: Olivier Albertini [email protected]

[codecov-io]

Codecov Report

Merging #128 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #128   +/-   ##
=======================================
  Coverage   98.74%   98.74%           
=======================================
  Files          29       29           
  Lines        1915     1915           
  Branches      221      221           
=======================================
  Hits         1891     1891           
  Misses         24       24

[OlivierAlbertini]

We still need to have someone who add gitcop (or something equivalent)
Here the format that need to be set in gitcop if you want to make the scope optional %{type}(?%?{scope})?: %{description}

[draffensperger]

Will this be triggered by the CircleCI build?

[OlivierAlbertini]

Will this be triggered by the CircleCI build?

No. This will be triggered has a commit-msg hook (when you do git commit) to ensure that is standard. But it's not 100% safe, it can be skipped as well, e.g editing directly through Github... gitcop would be useful for that.

commitlint + husky is good to prevent that and avoid roundtrip

[mayurkale22]

If I don't add commit message in the correct format, at what stage I should expect to see the failure message? Is it when I open the pull request?

[OlivierAlbertini]

you won't be able to write a commit message if it's not standard , e.g

I do git commit -am "wrong message", you will see an error and the message won't be comitted.

[mayurkale22]

you won't be able to write a commit message if it's not standard , e.g

I do git commit -am "wrong message", you will see an error and the message won't be comitted.

hmm I see. Do you think we should add this in CONTRIBUTING.md guide?

[OlivierAlbertini]

sure @mayurkale22, this is a good idea.

[rochdev]

I'm not a fan of doing this on commit. When committing WIP I generally will defer thinking about the commit message to a later rebase. Any way we can trigger this at the PR stage as mentioned above?

[OlivierAlbertini]

You can do git commit -am "WIP" --no-verify to skip this When committing WIP

[OlivierAlbertini]

I added Conventional commit section to CONTRIBUTING.md under Before you start, let me know if anything is unclear.

[mayurkale22]

@draffensperger @rochdev @danielkhan Please approve the PR, if everything looks good.

[draffensperger]

Thanks @OlivierAlbertini for setting this up!

[rochdev]

LGTM. Does this apply to rebase as well?

[OlivierAlbertini]

yes

➜ git rebase -i af8a7e3450c8b1fb94c8b2182a90b109e77c89a1
husky > commit-msg (node v10.9.0)
⧗   input: ch: add commitlint and husky

Change CONTRIBUTING.md

Resolves #117

Signed-off-by: Olivier Albertini <[email protected]>
✖   type must be one of [ci, feat, fix, docs, style, refactor, perf, test, revert, chore] [type-enum]
⚠   footer must have leading blank line [footer-leading-blank]