docs: update docs #158
docs: update docs #158
Conversation
radeva
commented
Feb 19, 2018
radeva
commented
- update readme with more info about the forums and slack
- add PR template
- add CONTRIBUTING.md and DevelopmentWorkflow.md
- update readme with more info about the forums and slack - add PR template - add CONTRIBUTING.md and DevelopmentWorkflow.md
ghost
assigned
DevelopmentWorkflow.md
Outdated
|
|
||
| 3. Build the app for Android or iOS | ||
| ```bash | ||
| tns run android/ios |
There was a problem hiding this comment.
if only building, then command could be changed to
tns build android
# or
ths build iosSomeone might try running tns run android/ios and get The input is not valid sub-command for 'run' command.
There was a problem hiding this comment.
This is true. I will change the commands, let's still discuss if build or run should be used.
|
|
||
| ## PR Checklist | ||
|
|
||
| - [ ] The PR title follows our guidelines: https://github.com/NativeScript/NativeScript/blob/master/CONTRIBUTING.md#commit-messages. |
There was a problem hiding this comment.
the PR title or the commit messages?
There was a problem hiding this comment.
Well, it's the title and the body of the message. The rules for the commit message are valid for the PR as well. We can think about how to say it better.
DevelopmentWorkflow.md
Outdated
|
|
||
| ### Prerequisites | ||
|
|
||
| * Install your native toolchain and NativeScript as [described in the docs](https://docs.nativescript.org/plugins/plugins) |
There was a problem hiding this comment.
yep, it is. It links to "Using Plugins" section.
DevelopmentWorkflow.md
Outdated
| ### Install dependencies | ||
|
|
||
| ``` | ||
| $ cd nativescript-imagepicker/src |
There was a problem hiding this comment.
npm run demo.android will make npm i for you
There was a problem hiding this comment.
This is true. I wanted to separate the actions you do on the plugin and the ones you do on the demo to make it more visible to the user. We can discuss which is better.
DevelopmentWorkflow.md
Outdated
| $ npm run demo.android | ||
| ``` | ||
|
|
||
| ### Run the demo-angular app |
There was a problem hiding this comment.
why running the Angular app should be different from running the TS app?
There was a problem hiding this comment.
We don't have npm commands for running the demo app. We can think of explaining how to the run a demo app from its folder only.
| ## Get Help | ||
| Please, use [github issues](https://github.com/NativeScript/nativescript-imagepicker/issues) strictly for [reporting bugs](CONTRIBUTING.md#reporting-bugs) or [requesting features](CONTRIBUTING.md#requesting-new-features). For general questions and support, check out the [NativeScript community forum](https://discourse.nativescript.org/) or ask our experts in [NativeScript community Slack channel](http://developer.telerik.com/wp-login.php?action=slack-invitation). | ||
|  |
There was a problem hiding this comment.
This is some tracking that exists across all main repos. I added it here for completeness, but if nobody is reviewing the stats, probably we can remove it.
