Skip to content

Latest commit

 

History

History
131 lines (84 loc) · 5.07 KB

CONTRIBUTING.md

File metadata and controls

131 lines (84 loc) · 5.07 KB

Contributing

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

Development workflow

Overview

This project is a monorepo managed using Yarn workspaces. It contains the following packages:

  • The main library package in the root directory.
  • An example app in the example/ directory.

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

Run yarn in the root directory to install the required dependencies for each package:

yarn

Since the project relies on Yarn workspaces, you cannot use npm for development without manually migrating.

Example app

The example app demonstrates usage of the library. You need to run it to test any changes you make.

It is configured to use the local version of the library, so any changes you make to the library's source code will be reflected in the example app. Changes to the library's JavaScript code will be reflected in the example app without a rebuild, but native code changes will require a rebuild of the example app.

If you want to use Android Studio or Xcode to edit the native code, you can open the example/android or example/ios directories respectively in those editors.

  • To edit the Objective-C or Swift files, open example/ios/SnackbarExample.xcworkspace in Xcode and find the source files at Pods > Development Pods > react-native-snackbar.
  • To edit the Java or Kotlin files, open example/android in Android Studio and find the source files at react-native-snackbar under Android.

You can use various commands from the root directory to work with the example project.

To start the packager:

yarn example start

To run the example app on Android (make sure to use the JDK version specified in .sdkmanrc):

yarn example android

To run the example app on iOS (make sure to use the ruby version specified in .ruby-version):

yarn example ios

To confirm that the app is running with the new architecture, you can check the Metro logs for a message like this:

Running "SnackbarExample" with {"fabric":true,"initialProps":{"concurrentRoot":true},"rootTag":1}

Note the "fabric":true and "concurrentRoot":true properties.

Tips

Make sure your code passes TypeScript:

yarn typecheck

To check for linting errors, run the following:

yarn lint

To fix formatting errors, run the following:

yarn lint --fix

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

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

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.

  1. Set up authorization: as of 2026, npm requires a passkey to sign in AND an OTP to deploy, which is mutually exclusive and senseless, so it must be routed around by creating a temporary access token online that bypasses 2FA. First npm logout then save the token value to ~/.npmrc as //registry.npmjs.org/:_authToken=npm_foo.

  2. To publish new versions, run yarn release and follow the prompts.

Scripts

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

  • yarn: setup project by installing dependencies.
  • yarn typecheck: type-check files with TypeScript.
  • yarn lint: lint files with ESLint.
  • yarn test: run unit tests with Jest.
  • yarn example start: start the Metro server for the example app.
  • yarn example android: run the example app on Android.
  • yarn 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.