This repository has been archived by the owner on Apr 7, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add CONTRIBUTING.md and update README (#11)
* add CONTRIBUTING.md and update README * address pr review requests
- Loading branch information
Showing
2 changed files
with
49 additions
and
4 deletions.
There are no files selected for viewing
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| # Contributing to Turtle CLI | ||
|
|
||
| ## How to contribute | ||
| You can contribute to Turtle CLI in various ways, including: | ||
| - [Reporting bugs or issues](https://github.com/expo/turtle/issues/new) on GitHub. Please make sure to fill in all the details suggested by the template to make sure the issue can be addressed as quickly as possible. | ||
| - [Submitting improvements to the documentation](https://github.com/expo/expo/tree/master/docs). Updates, enhancements, new guides, spelling fixes… | ||
| - Helping other people on [Expo Forums](https://forums.expo.io/) and on [Expo Developers Slack](http://slack.expo.io). | ||
| - Looking at existing [issues](https://github.com/expo/turtle/issues) and adding more information, particularly helping to reproduce the issues. | ||
| - [Submitting a pull request](#submitting-a-pull-request) with a bug fix or an improvement. | ||
|
|
||
| ## Turtle CLI repository | ||
|
|
||
| ### Codebase | ||
| This repository contains the codebase for the `turtle-cli` NPM package. The same codebase is used to run standalone app builders on the Expo servers. | ||
|
|
||
| ### Branches | ||
| The `master` branch of the repository should be kept releasable at any time. This way we can continuously release fixes and improvements without costly managing of different branches and issues will be noticed and fixed quickly. This also ensures other contributors can check out the latest version from GitHub and work on it with minimal disruption from other features in progress. | ||
|
|
||
| ## Setting up the repository for development | ||
| *TODO* | ||
|
|
||
| ## Submitting a pull request | ||
| To submit a pull request: | ||
| 1. Fork the [repository](https://github.com/expo/turtle) and create a feature branch. (Existing contributors can create feature branches without forking. Prefix the branch name with `@your-github-username/`.) | ||
| 2. Write the description of your pull request. Make sure to include a test plan and test your changes. | ||
| 3. Make sure all tests pass on CircleCI. | ||
| 4. Wait for a review and adjust the code if necessary. | ||
|
|
||
| ## Publishing a release | ||
| - To release a new version of `turtle-cli`, run `yarn release` command. | ||
| - If you wish to release a new *beta* version of `turtle-cli`, run `yarn release:beta` instead. |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,25 +1,39 @@ | ||
| # Turtle CLI | ||
|
|
||
| [](https://github.com/expo/turtle/blob/master/LICENSE) | ||
| [](https://npmjs.com/package/turtle-cli) | ||
| [](https://circleci.com/gh/expo/turtle) | ||
| [](https://npmjs.com/package/turtle-cli) | ||
| [](https://github.com/expo/turtle/blob/master/LICENSE) | ||
|
|
||
| [](http://slack.expo.io) | ||
| [](https://forums.expo.io/) | ||
|
|
||
| Turtle CLI is a command line interface for building Expo standalone apps. | ||
| You can use it both on your CI and your private computer. | ||
|
|
||
| ### Glossary | ||
| - [Changelog](CHANGELOG.md) | ||
| - [Contributing to Turtle CLI](CONTRIBUTING.md) | ||
| - [Code of Conduct](CODE_OF_CONDUCT.md) | ||
|
|
||
| ## Glossary | ||
| - **Turtle** - script which takes a shell app, fills it with user's code and produces a standalone app | ||
| - **Shell app** — precompiled (in case of iOS builds) Expo app which doesn't have user's code | ||
| - **Standalone app** - .ipa/.apk file, a user uploads standalone apps to the Google Play Store/Apple App Store | ||
|
|
||
| ## Installation | ||
|
|
||
| [Installation instructions and documentation here.](https://docs.expo.io/versions/latest/distribution/turtle-cli) | ||
|
|
||
| ## Usage example | ||
| See the [expo/turtle-cli-example](https://github.com/expo/turtle-cli-example) repository to learn how to use Turtle CLI in order to build Expo standalone apps on your CI. | ||
|
|
||
| ## Do you need help? | ||
| - Make sure you've read [the Expo Docs](https://docs.expo.io/), especially [Building Standalone Apps on Your CI | ||
| ](https://docs.expo.io/versions/latest/distribution/turtle-cli) and [Building Standalone Apps](https://docs.expo.io/versions/latest/distribution/building-standalone-apps) guides. | ||
| - Search for existing GitHub issues [in this repository](https://github.com/expo/turtle/issues) and in [expo/expo](https://github.com/expo/expo/issues) repository. | ||
| - Ask for help in **one** of the following ways: | ||
| * create [a GitHub issue](https://github.com/expo/turtle/issues/new). | ||
| * create a new topic on [Expo Forums](https://forums.expo.io/). | ||
| * ask a question on [Expo Developers Slack](http://slack.expo.io). | ||
|
|
||
| ## License | ||
| The Turtle CLI source code is made available under the [MIT license](LICENSE). | ||
| Some of the dependencies are licensed differently, with the BSD license, for example. |