Skip to content

Latest commit

 

History

History
95 lines (78 loc) · 4.75 KB

CONTRIBUTING.md

File metadata and controls

95 lines (78 loc) · 4.75 KB
Raw

Contribute to the Telerik AppBuilder Command-Line Interface

Help us improve the Telerik AppBuilder CLI

Telerik AppBuilder

The Telerik AppBuilder CLI lets you build, test, deploy, and publish hybrid mobile apps for iOS, Android, and Windows Phone 8 from your favorite IDE or code editor. You can develop your projects locally from the convenience of your favorite code editor and run the command-line to test, build, deploy in the simulator or on devices, and publish your applications to the App Store or Google Play.

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. To help us investigate your issue and respond in a timely manner, you can provide is with the following details.

  • Overview of the issue: Provide a short description of the visible symptoms. If applicable, include error messages, screen shots, and stack traces.
  • Motivation for or use case: Let us know how this particular issue affects your work.
  • Telerik AppBuilder version(s): List the current version and build number of the CLI interface. You can get it by running $ appbuilder --version. Let us know if you have not observed this behavior in earlier versions and if you consider it a regression.
  • System configuration: Provide us with relevant system configuration information such as operating system, network connection, proxy usage, etc. Let us know if you have been able to reproduce the issue on multiple setups.
  • Steps to reproduce: If applicable, submit a step-by-step walkthrough of how to reproduce the issue.
  • Related issues: If you discover a similar issue in our archive, give us a heads up - it might help us identify the culprit.
  • Suggest a fix: You are welcome to suggest a bug fix or pinpoint the line of code or the commit that you believe has introduced the issue.

Back to Top

Request a Feature

You can request a new feature by submitting an issue with the enhancement label to our GitHub Repository. 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

First, read our developers documentation.

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

  • Search GitHub for an open or closed Pull Request that relates to your submission.
  • Make your changes in a new git branch. We use the Gitflow branching model so you will have to branch from our develop branch.
    git checkout -b my-fix-branch develop
  • Create your patch and include appropriate test cases.
  • Commit your changes and create a descriptive commit message (the commit message is used to generate release notes).
    git commit -a
  • Build your changes locally.
    grunt
  • Ensure all the tests pass.
    grunt test
  • Push your branch to GitHub.
    git push origin my-fix-branch
  • In GitHub, send a Pull Request to icenium-cli:develop.
  • 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 develop -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 develop branch.
    git checkout develop -f
  • Delete the local branch.
    git branch -D my-fix-branch
  • Update your develop branch with the latest upstream version.
    git pull --ff upstream develop

Back to Top