Skip to content

Latest commit

 

History

History
148 lines (95 loc) · 5.82 KB

CONTRIBUTING.md

File metadata and controls

148 lines (95 loc) · 5.82 KB
Raw

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.

  1. Fork the repo and create your branch from master (a guide on how to fork a repository).
  2. Run yarn or npm install to install all required dependencies.
  3. Run yarn watch to automatically build the changed files.
  4. 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

Please make sure the version of React Native matches the one present in devDependencies of the CLI. Otherwise, you may get unexpected errors.

Because of a modular design of the CLI, we recommend developing using symbolic links to its packages. This way you can use it seamlessly in the tested project, as you'd use the locally installed CLI. Here's what you need to run in the terminal:

cd /path/to/cloned/project/
yarn link-packages

And then:

cd /my/new/react-native/project/
yarn link "@react-native-community/cli-platform-ios" "@react-native-community/cli-platform-android" "@react-native-community/cli" "@react-native-community/cli-types" "@react-native-community/cli-tools" "@react-native-community/cli-debugger-ui"

npx react-native run-android

Once you're done with testing and you'd like to get back to regular setup, run yarn unlink instead of yarn link from above command. Then yarn install --force.

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
yarn global add verdaccio
  • Run verdaccio
verdaccio
  • Set npm registry to verdaccio proxy server
npm set registry http://localhost:4873/
  • Clone react-native and @react-native-community/cli
  • Release new version of @react-native-community/cli to local npm proxy. If you have any issues, head over to 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.
# 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
# RN_VERSION is the version of localy released react-native
react-native init --version ${RN_VERSION}
  • Cleanup
npm config set registry https://registry.npmjs.org/

Running start command

In order for symlinks to work correctly when running start locally, set REACT_NATIVE_APP_ROOT as the root folder of your cli project:

REACT_NATIVE_APP_ROOT=path/to/cli node path/to/cli/packages/cli/build/index.js start

Running CLI with React Native from the source

First make sure you have RN repo checked out and CLI repo checked out and built. Then you can start a new RN project with local version of CLI and RN without publishing or proxy:

  1. Check out react-native repo. Then update template in local react-native/template/package.json, replacing dependency version of react-native with the absolute path of the react native repo, for example: "react-native": "file:///Users/username/react-native" (you can find the absolute path using pwd command)

  2. Go back up and create a new RN project: node ./cli/packages/cli/build/index.js init --template=file:///path/to/local/react-native RNTestProject

  3. To work with android, update gradle config in the newly created project following the second part of Christoph's instructions

  4. Run start (as described above) and compile your app eg node ../cli/packages/cli/build/index.js run-android (make sure you definitely have NDK r17c installed before building android)

Typechecking, linting and testing

Currently we use TypeScript for typechecking, eslint with prettier for linting and formatting the code and jest for testing.

  • 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 TypeScript, 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. 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.