-
-
Notifications
You must be signed in to change notification settings - Fork 597
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
V2 docs/remove commit validator #222
V2 docs/remove commit validator #222
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! Thanks! Yeah, if you could add npm run prepare / yarn prepare
to the docs, that would be great!
.gitignore
Outdated
@@ -1,4 +1,5 @@ | |||
# External dependencies | |||
.idea # webstorm/intelliJ ide's etc |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Replace the external dep
with ide folders
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sure, sorted 👍
|
@@ -31,7 +31,6 @@ In case you are suggesting a new feature, we will match your idea with our curre | |||
*Note: Node 6 or greater would be better for "best results".* | |||
* Fork the **webpack-cli** repo at [https://github.com/webpack/webpack-cli](https://github.com/webpack/webpack-cli). | |||
* `git clone <your-clone-url> && cd webpack-cli` | |||
* Install the commit validator: `npm run install-commit-validator` | |||
|
|||
### Setup with npm | |||
* Install the dependencies: `npm install` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
add npm prepare
after the install statement, same for yarn
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ah - seems like prepare is a lifecycle hook for both yarn and npm I wasn't aware of. which means it is auto-run after install.
yarnpkg/yarn#3004
https://iamakulov.com/notes/npm-4-prepublish/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
gotcha! I tend to do it after installing based on habit 😆
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM thanks @peter-mouland! Do you want any other issues to work with?
@ev1stensberg feel free to let me know anything else that would help you out. I'll see what I can do that doesn't clash with whatever you're already working on. |
What kind of change does this PR introduce?
Update Documentation for v2
Did you add tests for your changes?
n/a
If relevant, did you update the documentation?
yes
Summary
Removed any mention of
commit-validator
as it is no longer relevant.I did see a task
prepare
is this aprepublish
task? or should the docs now mention this?Does this PR introduce a breaking change?
n/a
Other information