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: add instructions to use the package installed locally #3626

Merged
merged 1 commit into from Jul 3, 2023

Conversation

donaminos
Copy link
Contributor

Description

The instructions regarding local setup wee a bit confusing, particularly in the "Add hook" section where npx was used to run commitlint instead of the locally installed package.

I have updated the instructions to provide greater clarity and accommodate those who prefer a 100% local setup. The revised steps now include guidance on utilizing the locally installed commitlint package.

Motivation and Context

When I read the documentation to use commitlint I was confused by the local setup using npx to run the command instead of the package installed locally

Usage examples

npm pkg set scripts.commitlint="commitlint --edit"
npx husky add .husky/commit-msg 'npm run commitlint ${1}'

How Has This Been Tested?

Follow the instructions on the doc, section Add hooks:

npm pkg set scripts.commitlint="commitlint --edit"
npx husky add .husky/commit-msg 'npm run commitlint ${1}'

Everything is working as before.

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)
  • Docs

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

Thanks!

@escapedcat escapedcat merged commit c2613aa into conventional-changelog:master Jul 3, 2023
9 checks passed
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