Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 2 commits into from
Jul 6, 2021

Conversation

hydrosquall
Copy link
Member

Motivation

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.

@hydrosquall hydrosquall mentioned this pull request Jul 3, 2021
11 tasks
@hydrosquall hydrosquall self-assigned this Jul 3, 2021
@hydrosquall hydrosquall added the documentation Changes only affect the documentation label Jul 3, 2021
@hydrosquall hydrosquall added the dependencies Update one or more dependencies version label Jul 4, 2021
Copy link
Member

@captainsafia captainsafia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@hydrosquall hydrosquall merged commit 0fc8c58 into main Jul 6, 2021
@github-actions
Copy link

🚀 PR was released in v8.2.12 🚀

@github-actions github-actions bot added the released This issue/pull request has been released. label Jul 14, 2021
@hydrosquall hydrosquall deleted the cameron.yick/commit-message-helper branch July 26, 2021 16:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Update one or more dependencies version documentation Changes only affect the documentation released This issue/pull request has been released.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants