Skip to content

docs: update build instructions in readme and contributing guide #3373

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

Merged
merged 2 commits into from
Feb 21, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 5 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,9 @@ Before you submit a Pull Request, consider the following guidelines.
```bash
git clone git@github.com:NativeScript/nativescript-cli.git
```
* Initialize the submodule.
* Run the setup script. This will initialize the git submodule, install the node dependencies and build with grunt.
```bash
git submodule init
```
* Fetch data from the submodule.
```bash
git submodule update
npm run setup
```
* Make your changes in a new `git` branch. We use the <a href="http://nvie.com/posts/a-successful-git-branching-model/">Gitflow branching model</a> so you will have to branch from our master branch.
```bash
Expand All @@ -57,15 +53,15 @@ Before you submit a Pull Request, consider the following guidelines.
* Create your patch and include appropriate test cases.
* Build your changes locally.
```bash
grunt
./node_modules/.bin/grunt
```
* Ensure all the tests pass.
```bash
grunt test
./node_modules/.bin/grunt test
```
* Ensure that your code passes the linter.
```bash
grunt lint
./node_modules/.bin/grunt lint
```
* Commit your changes and create a descriptive commit message (the commit message is used to generate release notes).
```bash
Expand Down
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -431,9 +431,7 @@ How to Build
```
git clone https://github.com/NativeScript/nativescript-cli
cd nativescript-cli
git submodule update --init
npm install
grunt
npm run setup
```

To use the locally built CLI instead `tns` you can call `PATH_TO_CLI_FOLDER/bin/tns`. For example:
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
},
"main": "./lib/nativescript-cli-lib.js",
"scripts": {
"setup": "git submodule update --init && npm i --ignore-scripts && ./node_modules/.bin/grunt",
"test": "node test-scripts/istanbul.js",
"postinstall": "node postinstall.js",
"preuninstall": "node preuninstall.js",
Expand Down