chore: set up + document commitizen-cli for authoring clear commit messages - Githubissues

nteract / data-explorer

The Data Explorer is nteract's automatic visualization tool.

https://data-explorer.nteract.io/

BSD 3-Clause "New" or "Revised" License

103 stars 12 forks source link

chore: set up + document commitizen-cli for authoring clear commit messages #68

Closed hydrosquall closed 3 years ago

hydrosquall commented 3 years ago

Motivation

We introduced #66 to help improve changelog generation, but developers may not remember the recommended prefixes. Using a CLI can help. (If people prefer not to use it, they can write commit messages normally).
https://github.com/nteract/data-explorer/issues/47#issuecomment-871830848

Changes

Followed the installation guide: https://github.com/commitizen/cz-cli
Put project config in a .czrc file instead of adding mysterious new properties to package.json
Documented usage in CONTRIBUTING.md + in a project badge in the top-level README

Testing

Tested yarn commit locally, and went through the interactive prompts to write both commit messages in this PR.

github-actions[bot] commented 3 years ago

:rocket: PR was released in v8.2.12 :rocket: