Skip to content

Latest commit

 

History

History
109 lines (91 loc) · 4.52 KB

CONTRIBUTING.md

File metadata and controls

109 lines (91 loc) · 4.52 KB
Raw

Contribute to the Telerik NativeScript Command-Line Interface

Help us improve the Telerik NativeScript CLI

Report an Issue

If you find a bug in the source code or a mistake in the documentation, you can submit an issue to our GitHub Repository. Before you submit your issue, search the archive to check if a similar issues has been logged or addressed. This will let us focus on fixing issues and adding new features. If your issue appears to be a bug, and hasn't been reported, open a new issue and select the Bug report option. To help us investigate your issue and respond in a timely manner, please follow the recommended bug report template.

Back to Top

Request a Feature

You can request a new feature by opening a new issue, selecting the Feature request option and following the recommended feature request template. If you want to implement a new feature yourself, consider submitting it to the GitHub Repository as a Pull Request.

Back to Top

Contribute to the Code Base

Before you submit a Pull Request, consider the following guidelines.

  • Search GitHub for an open or closed Pull Request that relates to your submission.
  • Clone the repository.
    git clone [email protected]:NativeScript/nativescript-cli.git
  • Run the setup script. This will initialize the git submodule, install the node dependencies and build with grunt.
    npm run setup
  • Make your changes in a new git branch. We use the Gitflow branching model so you will have to branch from our master branch.
    git checkout -b my-fix-branch master
  • Create your patch and include appropriate test cases.
  • Build your changes locally.
    ./node_modules/.bin/grunt
  • Ensure all the tests pass.
    ./node_modules/.bin/grunt test
  • Ensure that your code passes the linter.
    ./node_modules/.bin/grunt lint
    git commit -m "fix: my awesome fix"
  • Push your branch to GitHub.
    git push origin my-fix-branch
  • In GitHub, send a Pull Request to nativescript-cli:master.
  • If we suggest changes, you can modify your branch, rebase, and force a new push to your GitHub repository to update the Pull Request.
    git rebase master -i
    git push -f

That's it! Thank you for your contribution!

When the patch is reviewed and merged, you can safely delete your branch and pull the changes from the main (upstream) repository.

  • Delete the remote branch on GitHub.
    git push origin --delete my-fix-branch
  • Check out the master branch.
    git checkout master -f
  • Delete the local branch.
    git branch -D my-fix-branch
  • Update your master branch with the latest upstream version.
    git pull --ff upstream master

Back to Top

Updating the CLI Documentation

The CLI documentation is what you see when running the ns help command. This documentation is distributed as part of the CLI package and is generated from the *.md files that can be found in man_pages folder The output of the documentation is html static pages that are generated on post install hook of the CLI installation. In addition, documentation generation is triggered every time there is no html article for the respective help command that is executed.

In order to see a change applied in your development workspace after editing the *.md files, you can use the ns dev-generate-help command. This will trigger regeneration of all html files on your local environment. Mind that you need to run from the /bin folder of the nativescript_cli.

Back to Top