mirror of
https://github.com/expo/react-native-community-cli.git
synced 2026-11-14 19:11:48 -10:00
Kacper Wiszczuk
6d1be39b3c
Summary: Added section in `CONTRIBUTING.md`, explaining how to run `init` command localy. This might also be helpful in potential integration testing.
103 lines
3.8 KiB
Markdown
103 lines
3.8 KiB
Markdown
# Contributing to React Native CLI
|
|
|
|
## Development Process
|
|
|
|
All work on React Native CLI happens directly on GitHub. Contributors send pull requests which go through review process.
|
|
|
|
> **Working on your first pull request?** You can learn how from this *free* series: [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github).
|
|
|
|
1. Fork the repo and create your branch from `master` (a guide on [how to fork a repository](https://help.github.com/articles/fork-a-repo/)).
|
|
2. Run `yarn` or `npm install` to install all required dependencies.
|
|
3. Now you are ready to do the changes.
|
|
|
|
## Repository
|
|
|
|
Repository is splitted into two packages:
|
|
|
|
* `cli` - Historically, it was included in `react-native` package. Contains all the commands code.
|
|
* `global-cli` - Historically, it was a `react-native-cli` package and the only reason this package existed was to initialize an empty project.
|
|
|
|
## Testing your changes
|
|
|
|
You can test your changes by calling `cli.js` directly from the cloned repository. You need to make sure the version of React Native matches the one present in devDependencies of the CLI. Otherwise, you may get unexpected errors.
|
|
|
|
```sh
|
|
node /path/to/cloned/project/packages/cli/index.js
|
|
```
|
|
|
|
## Testing `init` command
|
|
|
|
You can test your changes by installing local npm proxy - `verdaccio`, and publishing custom versions of `@react-native-community/cli` and `react-native`.
|
|
|
|
* Install `verdaccio`
|
|
```sh
|
|
yarn global add verdaccio
|
|
```
|
|
* Run verdaccio
|
|
```sh
|
|
yarn verdaccio
|
|
```
|
|
* Set npm registry to `verdaccio` proxy server
|
|
```sh
|
|
npm set registry http://localhost:4873/
|
|
```
|
|
* Clone `react-native` and `@react-native-commiunity/cli`
|
|
* Release new version of `@react-native-community/cli` to local npm proxy. If you have any issues, head over to [verdaccio](https://github.com/verdaccio/verdaccio) and check out the docs.
|
|
```
|
|
cd /path/to/cli/packages/cli && npm publish
|
|
```
|
|
* Install new version of `@react-native-community/cli` in `react-native` and publish new version of it.
|
|
```sh
|
|
# RN_CLI_VERSION is the version of localy released cli
|
|
cd /path/to/react-native && yarn add @react-native-community/cli@${RN_CLI_VERSION} && npm publish
|
|
```
|
|
* You are ready to go
|
|
```sh
|
|
# RN_VERSION is the version of localy released react-native
|
|
react-native init --version ${RN_VERSION}
|
|
```
|
|
* Cleanup
|
|
```sh
|
|
npm config set registry https://registry.npmjs.org/
|
|
```
|
|
|
|
|
|
## Typechecking, linting and testing
|
|
|
|
Currently we use `flow` for typechecking, `eslint` with `prettier` for linting and formatting the code and `jest` for testing.
|
|
|
|
* `yarn flow`: run `flow`
|
|
* `yarn lint`: run `eslint` and `prettier`
|
|
* `yarn test`: run unit tests
|
|
|
|
## Commit message convention
|
|
|
|
We prefix our commit messages with one of the following to signify the kind of change:
|
|
|
|
* **build**: Changes that affect the build system or external dependencies
|
|
* **ci**, **chore**: Changes to our CI configuration files and scripts
|
|
* **docs**: Documentation only changes
|
|
* **feat**: A new feature
|
|
* **fix**: A bug fix
|
|
* **perf**: A code change that improves performance
|
|
* **refactor**: A code change that neither fixes a bug nor adds a feature
|
|
* **style**: Changes that do not affect the meaning of the code
|
|
* **test**: Adding missing tests or correcting existing tests
|
|
|
|
## Sending a pull request
|
|
|
|
When you're sending a pull request:
|
|
|
|
* Prefer small pull requests focused on one change.
|
|
* Verify that `flow`, `eslint` and all tests are passing.
|
|
* Preview the documentation to make sure it looks good.
|
|
* Follow the pull request template when opening a pull request.
|
|
|
|
## Reporting issues
|
|
|
|
You can report issues on our [bug tracker](https://github.com/react-native-community/react-native-cli/issues). Please follow the issue template when opening an issue.
|
|
|
|
## License
|
|
|
|
By contributing to React Native CLI, you agree that your contributions will be licensed under its **MIT** license.
|