Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
118 lines (75 loc) · 4.77 KB

CONTRIBUTING.md

File metadata and controls

118 lines (75 loc) · 4.77 KB
Raw

Contributing to React Native Paper

Code of Conduct

We want this community to be friendly and respectful to each other. Please read the full text so that you can understand what actions will and will not be tolerated.

Our Development Process

The core team works directly on GitHub and all work is public.

Development workflow

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 main (a guide on how to fork a repository).
  2. Use the Node.js version specified in .nvmrc.
  3. Run yarn on the root level, to setup the development environment.
  4. Do the changes you want and test them out in the example app before sending a pull request.

Commit message convention

We follow the conventional commits specification for our commit messages:

  • fix: bug fixes, e.g. fix Button color on DarkTheme.
  • feat: new features, e.g. add Snackbar component.
  • refactor: code refactor, e.g. new folder structure for components.
  • docs: changes into documentation, e.g. add usage example for Button.
  • test: adding or updating tests, eg unit, snapshot testing.
  • chore: tooling changes, e.g. change the CI configuration.
  • BREAKING CHANGE: for changes that break existing usage, e.g. change API of a component.

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

Linting and tests

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 type checking, linting, and tests pass when committing. You can also run the following commands manually:

  • yarn typecheck: type-check files with tsc.
  • yarn lint: lint files with eslint and prettier.
  • yarn test: run unit tests with jest.

Sending a pull request

When you're sending a pull request:

  • Prefer small pull requests focused on one change.
  • Verify that typecheck, lint and all tests are passing.
  • Preview the documentation to make sure it looks good.
  • Follow the pull request template when opening a pull request.

When you're working on a component:

  • Follow the guidelines described in the official material design docs.
  • Write a brief description of every prop when defining the props type to aid with documentation.
  • Provide an example usage for the component (check other components to get an idea).
  • Update the type definitions for TypeScript if you changed an API or added a component.

Running the example

The example app uses Expo development build for the React Native example.

First, generate the native projects:

yarn example expo prebuild

Then build and install the development build:

yarn example ios

or:

yarn example android

After you're done, you can run yarn example start in the project root and scan the QR code to launch it on your device, or press i, a or w to launch it on the iOS simulator, Android emulator, or web browser, respectively.

Testing a specific pull request/commit

If you want to test the changes brought by a pull request, you can do so by pointing at the git-commit or branch in your package.json file. For example:

{
  "dependencies": {
    "react-native-paper": "git+https://github.com/callstack/react-native-paper.git#<commit-hash>"
  }
}

Then run yarn install/npm install in your project to install the package from the git repository.

Alternatively, you may clone the react-native-paper repo and use the yalc tool to link the package to the project.

Working on documentation

To preview the documentation, run yarn docs dev in the project root.

Publishing a release

We use release-it to automate our release. If you have publish access to the NPM package, run the following from the main branch to publish a new release:

yarn release

NOTE: You must have a GITHUB_TOKEN environment variable available. You can create a GitHub access token with the "repo" access here.

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 Paper, you agree that your contributions will be licensed under its MIT license.