Skip to content

Update README.md to improve husky setup#3822

Merged
escapedcat merged 1 commit intoconventional-changelog:masterfrom
SyedTayyabUlMazhar:patch-1
Dec 13, 2023
Merged

Update README.md to improve husky setup#3822
escapedcat merged 1 commit intoconventional-changelog:masterfrom
SyedTayyabUlMazhar:patch-1

Conversation

@SyedTayyabUlMazhar
Copy link
Copy Markdown
Contributor

Explicitly mention that the hook file name must be commit-msg for husky

Description

Added a warning block in docs to make it clear that the name for husky hook file must be commit-msg.

Motivation and Context

A lot of people using this library with husky don't know about git hooks in general. So it's assumed that changing the name for hook file won't cause any problems. This change in documentation makes it clear that the name is actually really important.

Issue 3780

Usage examples

No usage

How Has This Been Tested?

No test required

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documenation

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Explicitly mention that the hook file name must be commit-msg for husky
@escapedcat
Copy link
Copy Markdown
Member

Let's try this, thanks!

@escapedcat escapedcat merged commit 83f18ae into conventional-changelog:master Dec 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants