Skip to content

Latest commit

 

History

History
101 lines (66 loc) · 3.82 KB

CONTRIBUTING.md

File metadata and controls

101 lines (66 loc) · 3.82 KB
Raw

Code Contribution Guidelines

Thank you for your interest in contributing! Please see the Mattermost Contribution Guide which describes the process for making code contributions across Mattermost projects and join our "Native Mobile Apps" community channel to ask questions from community members and the Mattermost core team.

When you submit a pull request, it goes through a code review process outlined here.

Development workflow

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

npm run bootstrap

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

To start the packager:

npm run example start

To run the example app on Android:

npm run example run android

To run the example app on iOS:

npm run example run ios

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

npm run typescript
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

To edit the Objective-C files, open example/ios/ReactNativePasteInputExample.xcworkspace in XCode and find the source files at Pods > Development Pods > @mattermost/react-native-paste-input.

To edit the Kotlin files, open example/android in Android studio and find the source files at mattermostreactnativepasteinput under Android.

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, eg 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:

  • npm run bootstrap: setup project by installing all dependencies and pods.
  • npm run typescript: type-check files with TypeScript.
  • npm run lint: lint files with ESLint.
  • npm run test: run unit tests with Jest.
  • npm run example start: start the Metro server for the example app.
  • npm run example android: run the example app on Android.
  • npm run example ios: run the example app on iOS.

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.