Skip to content

Latest commit

 

History

History
62 lines (40 loc) · 2.31 KB

CONTRIBUTING.md

File metadata and controls

62 lines (40 loc) · 2.31 KB
Raw

How much


How much

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue.

Setting up a development environment

  • Follow the React Native Guide for getting started building a project using Expo CLI.
  • Clone or download the repo
  • Copy and rename the file .env.example to .env and fill the necessary variables.
  • yarn to install dependencies
  • yarn android to start the packager and run the app in the the Android device/emulator
  • yarn ios to start the packager and run the app in the iOS simulator

Issues needing help

Are you out of ideas, but still wanna help? Check out the help wanted or the good first issue labels.

Code style

We have a pre-commit hook enforcing commits to follow our lint rules.

  • ESLint to enforce code style and best practices on JavaScript and TypeScript files.
  • Prettier to format JSON files.

To check for lint issues on your code, run this on your terminal:

yarn lint

And to auto-fix some of them:

yarn lint-fix

Tests

It's always important to ensure everything is working properly and that's why tests are great.

Unit tests

We use Jest for our unit tests. We have a pre-commit hook that prevents commits that breaks any test.

To check for test issues on your code, run this on your terminal:

yarn test

Commits

We enforce the commit messages to follow the Conventional Commits specification.

Pull request

The title of your PR should also follow the Conventional Commits specification.

Your PR is automatically inspected by various tools, check their response and try to improve your code accordingly. Requests that fail to build or have wrong coding style won't be merged.