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

docs(cz-commitlint): mention inquirer as peer dependency #3268

Merged
merged 1 commit into from Jul 5, 2022

Conversation

shian15810
Copy link
Contributor

"peerDependencies": {
"commitizen": "^4.0.3",
"inquirer": "^8.0.0"
},

Description

Mention inquirer as a peer dependency of @commitlint/cz-commitlint and guide users to install inquirer@8.

Motivation and Context

#3247 (comment) (cc @escapedcat)

Usage examples

npm install --save-dev @commitlint/cz-commitlint commitizen inquirer@8  # inquirer is required as peer dependency
# or yarn
yarn add -D @commitlint/cz-commitlint commitizen inquirer@8             # inquirer is required as peer dependency

How Has This Been Tested?

N/A

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)

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.

@escapedcat
Copy link
Member

escapedcat commented Jul 5, 2022

👏 Thank you!

@escapedcat escapedcat merged commit 39e5e0c into conventional-changelog:master Jul 5, 2022
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.

None yet

2 participants