Skip to content

Latest commit

 

History

History
107 lines (71 loc) · 3.65 KB

CONTRIBUTING.md

File metadata and controls

107 lines (71 loc) · 3.65 KB

Contributing

We want this community to be friendly and respectful to each other. Please follow it in all your interactions with the project.

Development workflow

To get started with the project, run yarn in the root directory to install the required dependencies for each package:

yarn

Install husky hooks by running:

npx husky install
yarn setup

While developing, you can run the example app to test your changes.

To start the package:

yarn dev

Make sure your code passes TypeScript and ESLint. Run the following to verify:

yarn typescript
yarn lint

To fix formatting errors, run the following:

yarn lint

Remember to add tests for your change if possible. Run the unit tests by:

yarn test

Commit message convention

We follow the conventional commits specification for our commit messages:

  • fix: bug fixes, e.g. fix crash due to deprecated method.
  • feat: new features, e.g. add new method to the module.
  • refactor: code refactor, e.g. migrate from class components to hooks.
  • docs: changes into documentation, e.g. add usage example for the module..
  • test: adding or updating tests, e.g. add integration tests using detox.
  • chore: tooling changes, e.g. change CI config.

Our pre-commit hooks verify that your commit message matches this format when committing.

Linting and tests

ESLint, Prettier, TypeScript

We use TypeScript for type checking, ESLint with Prettier for linting and formatting the code, and Jest for testing.

Our pre-commit hooks verify that the linter and tests pass when committing.

Scripts

The package.json file contains various scripts for common tasks:

  • yarn setup: installs husky hooks
  • yarn typescript: type-check files with TypeScript.
  • yarn lint: lint files with ESLint.
  • yarn test: run unit tests with Jest.
  • yarn dev: start the example app.
  • yarn prepush: run yarn typescript and yarn lint
  • yarn build: create a production build from src
  • yarn prepare: runs yarn build automatically before package is packed or published
  • yarn publish: publish the package

Sending a pull request

Working on your first pull request? You can learn how from this free series: How to Contribute to an Open Source Project on GitHub.

When you're sending a pull request:

  • Prefer small pull requests focused on one change.
  • Verify that linters and tests are passing.
  • Review the documentation to make sure it looks good.
  • For pull requests that change the API or implementation, discuss with maintainers first by opening an issue.

Releasing

Releasing a new version is mostly automated. For now the CHANGELOG requires being updated manually. Once this has been done run the commands below. Versions should follow semantic versioning.

npm publish

Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.