Skip to content

Commit

Permalink
docs(readme): add more info about prepare-commit-msg
Browse files Browse the repository at this point in the history
info about how the githook will add jira issue id as prefix to the commit message if the branch name starts with a string resembling one
  • Loading branch information
Mubashwer committed Apr 2, 2023
1 parent 24baf2f commit f7c9d3e
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ $ cargo install git-mob-tool

This [`githook`](https://git-scm.com/docs/githooks#_prepare_commit_msg) will be used to append the `Co-authored-by` trailers to the commit's message.

_This githook also adds a Jira Issue ID as a prefix to the commit message if the branch name starts with a string resembling one. If you don't want want this, comment out line 46 which calls the function `add_jira_issue_id_prefix`._
_This githook also adds a Jira Issue ID as a prefix to the commit message if the branch name starts with a string resembling one. If you don't want want this, comment out [line 46 which calls the function `add_jira_issue_id_prefix`](./prepare-commit-msg#LL46)._

## Usage

Expand Down

0 comments on commit f7c9d3e

Please sign in to comment.