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(pkg): readme info #497

Merged
merged 5 commits into from
Jun 29, 2018
Merged

docs(pkg): readme info #497

merged 5 commits into from
Jun 29, 2018

Conversation

ematipico
Copy link
Contributor

@ematipico ematipico commented Jun 8, 2018

What kind of change does this PR introduce?

Documentation. Part of #247

Did you add tests for your changes?
No
If relevant, did you update the documentation?
yes
Summary
Created read me file for info sub package

Does this PR introduce a breaking change?
No
Other information

Created read me file for info sub package

```bash
npm i -D @webpack-cli/info
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you add an example to this as well, and how to use it?

Copy link
Member

@dhruvdutt dhruvdutt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please change base branch to next? Having master ahead of next would cause next to rebase and force push every time master gets ahead.

@evenstensberg
Copy link
Member

@ematipico status on this?

@ematipico ematipico changed the base branch from master to next June 27, 2018 11:48
Copy link
Member

@evenstensberg evenstensberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll include a command section as well in the usage section, both by importing and by invoking webpack.cli

todo:

  1. Add invocation through webpack-cli section
  2. Add invocation through node section

This should be standard for all the readme files in packages.

@webpack-bot
Copy link

@ematipico Thanks for your update.

I labeled the Pull Request so reviewers will review it again.

@ev1stensberg Please review the new changes.

@ematipico
Copy link
Contributor Author

PTAL

@@ -0,0 +1,24 @@
# webpack-cli Info
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small I and otherwise good to go, thanks @ematipico !

@webpack-bot
Copy link

@ematipico The most important CI builds failed. This way your PR can't be merged.

Please take a look at the CI results from travis (failure) and fix these issues.

Copy link
Member

@evenstensberg evenstensberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm :shipit:

@ematipico ematipico merged commit 46d950f into next Jun 29, 2018
@ematipico ematipico deleted the feature/readme-info branch June 29, 2018 07:55
dhruvdutt pushed a commit to dhruvdutt/webpack-cli that referenced this pull request Jul 4, 2018
* docs(pkg): readme info

Created read me file for info sub package

* docs(readme):  added usage example

* Updated usage

* Fixed correct package

* docs(info): small typo
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants