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.

Sign up for GitHub

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

feat:Commitizen pre commit hook #37

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

feat:Commitizen pre commit hook #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2bd0507
feat: add commitizen to format commit messages
mushroomgenie Apr 15, 2024
da007d6
docs: add commit message instruction in docs
mushroomgenie Apr 15, 2024
91f9f13
fix: change core.editor to cat
mushroomgenie Apr 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .husky/prepare-commit-msg
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

exec < /dev/tty && npx cz --hook || true
6 changes: 6 additions & 0 deletions docs/DeveloperGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
* [Design](#design)
* [Code Documentation](#code-documentation)
* [Testing](#testing)
* [Commit Messages](#commit-messages)
* [Pull Requests](#pull-requests)
* [Final Notes](#final-notes)

Expand Down Expand Up @@ -131,6 +132,11 @@ Finally, if you would like to, you can then also build the library with `npm run

Note: As of version **1.3.0**, the chatbot also comes with streaming messages as a feature. Should you decide to run tests against stream messages, you may wish to increase the `WAIT_DURATION` and set `HEADLESS` to `false` in _test/config.js_.


## Commit Messages

Commitizen([cz-cli](https://github.com/commitizen/cz-cli)) is used in this repository to handle and prepare commit messages. All you need to do is run `git commit` and then commit using the interactive interface in the terminal.

## Pull Requests

If you are satisfied with your changes and would like to **contribute back to the project** (which we strongly encourage you to!), feel free to open a pull request to the master branch.
Expand Down
Loading