Update README with PR testing process & yarn dependency mgmt notes #231
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
ghost
assigned 
artlowel
reviewed
Mar 5, 2018
README.md
Outdated
| yarn creates the file [`yarn.lock`](https://yarnpkg.com/en/docs/yarn-lock) to track those versions. That file is updated automatically every time you install a new dependency from the commandline (by using `yarn add some-lib --save` or `yarn add some-lib --save-dev`). | ||
| * `yarn` creates a [`yarn.lock`](https://yarnpkg.com/en/docs/yarn-lock) to track those versions. That file is updated automatically by whenever dependencies are added/updated/removed via yarn. | ||
| * **Adding new dependencies**: To install/add a new dependency (third party library), use [`yarn add`](https://yarnpkg.com/en/docs/cli/add). For example: `yarn add some-lib --save`. | ||
| * If it's a development-only dependency (not for production), use `yarn add some-lib --save-dev` |
There was a problem hiding this comment.
If it's a development-only dependency (not for production)
This is more about build tools vs dependencies, rather than development vs production. Dependencies that are only needed to build the project like a typescript compiler, or webpack (an analogy with dspace's java code would be maven or ant) are dev dependencies, while things that need to end up in the built code, like angular itself, or bootstrap (for java: apache.commons, or solr) are regular dependencies.
There was a problem hiding this comment.
Thanks for the notes, @artlowel . I've updated the README to clarify, and also rebased on master (so that the Travis build errors go away)
artlowel
approved these changes
Mar 6, 2018
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.
Per our meeting last week, I've updated the README with:
@artlowel , could you give this a quick review to ensure it looks correct?