Update README for when to run npm run build
#1319
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
astorije
reviewed
Jul 19, 2017
README.md
Outdated
| @@ -61,10 +61,11 @@ your own risk. It is also not recommended to run this as root. | |||
| ## Development setup | |||
|
|
|||
| Simply follow the instructions to run The Lounge from source above, on your own | |||
| fork. | |||
| fork. Be sure to check out `package.json` for available npm scripts that may help or be necessary for your changes. | |||
There was a problem hiding this comment.
I don't think this is really necessary. Any specific use case why you added it?
astorije
reviewed
Jul 19, 2017
|
|
||
| Before submitting any change, make sure to: | ||
|
|
||
| - Read the [Contributing instructions](https://github.com/thelounge/lounge/blob/master/CONTRIBUTING.md#contributing) | ||
| - Run `npm test` to execute linters and test suite | ||
| - Run `npm run build` if you change or add anything in `client/js/libs` or `client/views` | ||
| - Run `npm run build` if you change or add anything in `client/js` or `client/views` |
astorije
reviewed
Jul 19, 2017
README.md
Outdated
|
|
||
| Before submitting any change, make sure to: | ||
|
|
||
| - Read the [Contributing instructions](https://github.com/thelounge/lounge/blob/master/CONTRIBUTING.md#contributing) | ||
| - Run `npm test` to execute linters and test suite | ||
| - Run `npm run build` if you change or add anything in `client/js/libs` or `client/views` | ||
| - Run `npm run build` if you change or add anything in `client/js` or `client/views` | ||
| - Run `npm run start-dev` to start an instance that will watch for changes and rebuild automatically |
There was a problem hiding this comment.
Well, to be fair, this is in the list for "Before submitting any change, make sure to:", so I either don't think we need it, or that this is the right section to add this.
Maybe this section should only contain reading the CONTRIBUTING file + running tests, and then another section (before or after) to help development where you mention npm run build, npm run watch, npm run start-dev and npm run start would be more appropriate.
need to `npm run build` a lot more since webpack was added
MaxLeiter
changed the title
npm run buildnpm run build
|
Simplified a lot, now only fixes the mistake. |
astorije
approved these changes
Jul 20, 2017
astorije
added
the
Type: Documentation
AlMcKinlay
approved these changes
Jul 20, 2017
matburnham
pushed a commit
to matburnham/lounge
that referenced
this pull request
Sep 6, 2017
Update README for when to run `npm run build`
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.