Skip to content

Latest commit

 

History

History
55 lines (34 loc) · 2.23 KB

CONTRIBUTING.md

File metadata and controls

55 lines (34 loc) · 2.23 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

The code is in package/, and the Example app (package/example/) is used for testing and development.

Open the Example app in Xcode or Android Studio to work on react-native-filament.

Before committing, run yarn check-all to format and lint the project.

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.
  • perf: various performance improvements.
  • docs: changes into documentation, e.g. add usage example for the module..
  • chore: tooling changes, e.g. change CI config.

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

Publishing to npm

We use release-it to make it easier to publish new versions. It handles common tasks like bumping version based on semver, creating tags and releases etc.

To publish new versions, run the following:

yarn release

Scripts

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

  • yarn: setup project by installing dependencies.
  • yarn check-all: lint and format the project's C++ and JS codebase.
  • yarn typescript: type-check files with TypeScript.

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.