docs: add instructions to use the package installed locally #3626
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 usingnpx
to run the command instead of the package installed locallyUsage examples
How Has This Been Tested?
Follow the instructions on the doc, section
Add hooks
:Everything is working as before.
Types of changes
Checklist: