Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
98 lines (65 loc) · 3.3 KB

CONTRIBUTING.md

File metadata and controls

98 lines (65 loc) · 3.3 KB

Contributing

Contributions are always welcome, no matter how large or small!

We want this community to be friendly and respectful to each other. Please follow it in all your interactions with the project. Before contributing, please read the code of conduct.

Development workflow

This repository contains a single React Native UI library package.

To get started, make sure you have the correct version of Node.js installed. See the .nvmrc file for the version used in this project.

Install dependencies in the root directory:

npm install

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

npm run typecheck
npm run lint

To fix formatting errors, run the following:

npm run lint -- --fix

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

npm 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.

Publishing to npm

Maintainers can publish a new version to npm using standard npm commands. Ensure you are logged in with the correct account and have publish rights.

  1. Bump the version (choose one):

    • Patch: npm version patch
    • Minor: npm version minor
    • Major: npm version major

  2. Build the package (runs via prepare):

    npm run prepare

  3. Publish:

    npm publish --access public

Scripts

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

  • npm install: setup project by installing dependencies.
  • npm run typecheck: type-check files with TypeScript.
  • npm run lint: lint files with ESLint.
  • npm test: run unit tests with Jest.
  • npm run prepare: build the library using Bob.

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.
  • Follow the pull request template when opening a pull request.
  • For pull requests that change the API or implementation, discuss with maintainers first by opening an issue.