Skip to content

Latest commit

 

History

History
57 lines (36 loc) · 2.67 KB

CONTRIBUTING.md

File metadata and controls

57 lines (36 loc) · 2.67 KB
Raw

Contributing to React Native User Avatar

Development Process

I am an individual wokring on this project, all the work is public and presented on GitHub.

Development workflow

  1. Fork the repo and create your branch from master (a guide on how to fork a repository).
  2. Run yarn bootstrap to setup the development environment.
  3. 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 commit messages:

  • fix: bug fixes, e.g. fixed issues with custom component.
  • feat: new features, e.g. added a prop or a capability.
  • refactor: code refactor, e.g. new folder structure.
  • docs: changes into documentation, e.g. add usage example.
  • test: adding or updating tests, eg unit, snapshot testing.
  • chore: tooling changes, e.g. change travis.yml config.
  • BREAKING CHANGE: for changes that break existing usage, e.g. changed usage.

The built-in pre-commit hooks verify that your commit message matches this format when committing.

Linting and tests

We use typescript for type checking, eslint for linting and formatting the code, and jest for testing. Our pre-commit hooks verify that the linter and tests pass when commiting. You can also run the following commands manually:

  • yarn typescript: type-check files with tsc.
  • yarn lint: lint files with eslint.
  • 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 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.
  • Update the type definitions for Typescript if you changed an API or added a prop.

Running the example

The example app uses Expo for the React Native example. You will need to install the Expo app for Android and iOS to start developing.

After you're done, you can run yarn example start in the project root (or expo start in the Example/ folder) and scan the QR code to launch it on your device.

Reporting issues

You can report issues on the bug tracker. Please follow the issue template when opening an issue.

License

By contributing to React Native User Avatar, you agree that your contributions will be licensed under its MIT license.