docs(readme): Update readme and add Contributing.md #1170
Merged
Conversation
This file contains hidden or 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
Contributor
radeva
commented
Jan 25, 2018
- add more description about the repo in the readme
- add Get Help section in the readme
- move local setup to DevelopmentWorkflow.md
- add contributing.md guide
sis0k0
reviewed
Jan 26, 2018
DevelopmentWorkflow.md
Outdated
| ## Developer workflow: | ||
|
|
||
| ### Setup: | ||
| Use `npm link` to link `nativescript-angular` in `tests` and `ng-sample` projects: |
There was a problem hiding this comment.
If you are using npm5, the package will be linked on npm install. Since npm5 is lts now, I think we can remove the usage of npm link from the setup.
DevelopmentWorkflow.md
Outdated
| ``` | ||
| $ cd ng-sample | ||
| $ npm install | ||
| $ npm install ../nativescript-angular |
There was a problem hiding this comment.
We can drop this, because the package.json now points to ../nativescript-angular.
DevelopmentWorkflow.md
Outdated
| ``` | ||
| $ cd tests | ||
| $ npm install | ||
| $ npm install ../nativescript-angular |
DevelopmentWorkflow.md
Outdated
| Start test run: | ||
|
|
||
| ``` | ||
| $ tns test ios --emulator |
There was a problem hiding this comment.
We can drop the --emulator flag.
|
It looks great! We can also add a note about running the e2e tests. Something similar to this: https://github.com/NativeScript/nativescript-dev-webpack/pull/424/files |
|
@sis0k0 All the comments are addressed. Feel free to merge this PR or get back with more comments. |
sis0k0
approved these changes
Jan 31, 2018
added 6 commits
February 5, 2018 17:20
- add more description about the repo in the readme - add Get Help section in the readme - move local setup to DevelopmentWorkflow.md - add contributing.md guide
- remove npm link usage since it is supported out of the box in npm 5 (currently LTS) - remove installation of '../nativescript-angular' since it's part of the package.json - remove --emulator flag
Describe the steps to run plugin end-2-end tests with Appium
9d2e394 to
c7d5804
Compare
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.