🧩 Feature: Document husky usage on main README

[iamkacperwasik]

Describe the solution you'd like

  "husky": {
    "hooks": {
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
      "prepare-commit-msg": "exec < /dev/tty && git cz --hook || true"
    }
  },

[KL13NT]

It already runs a pre-commit hook on my machine, doesn't it on yours?

[KL13NT]

The configuration is setup in package.json to lint commit messages before they're admitted, and if the linting process returns errors it'll stop the whole commit. ESLint, Prettier, and Jest are set to run on precommit as well.

[iamkacperwasik]

"prepare-commit-msg": "exec < /dev/tty && git cz --hook || true"

runs commitizen on git commit like you were to type yarn commit

[KL13NT]

The || true part provides undefined behavior on Windows. There's an open issue about it.

And I just remembered that in the committing section of the contribution guide it's mentioned that this is left out by choice.

If you know what the Angular commit format is and have used it before alongside standard-version then by all means feel free to commit as you usually do after running npm run precommit. Note though that your commit messages will be checked by husky to make sure they're compliant either way.

I don't wish to go through the CLI slow process every time, provided I already know the correct format, etc. Husky will run after I commit normally, and that should be enough delay for an advanced user. Do you think this should be documented in the repo's README?

[iamkacperwasik]

I think we should mention this, because for someone it can be difficult at the beggining to use the convention, especially remember to type yarn commit, but I can agree that this approach isn't the best for people who already knows it and don't have to mess around with it.

[KL13NT]

Done in 005e044.