Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
176 lines (117 loc) · 5.74 KB

CONTRIBUTING.md

File metadata and controls

176 lines (117 loc) · 5.74 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

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

  • The 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.

If you don't have pnpm installed, install it first:

npm install -g pnpm

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

pnpm install

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

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.

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

To start the packager:

pnpm example start

To run the example app on Android:

pnpm example android

To run the example app on iOS:

pnpm 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 "CoachmarkExample" with {"fabric":true,"initialProps":{"concurrentRoot":true},"rootTag":1}

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

To run the example app on Web:

pnpm example web

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

pnpm typecheck
pnpm lint

To fix formatting errors, run the following:

pnpm lint --fix

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

pnpm test

Adding a Changeset

Important: All changes that affect the public API require a changeset.

After making your changes, create a changeset by running:

npx changeset

This will prompt you to:

  1. Select which package(s) are affected (select @edwardloopez/react-native-coachmark)
  2. Choose the type of change:
    • patch - Bug fixes, small improvements
    • minor - New features, non-breaking changes
    • major - Breaking changes
  3. Write a summary describing your changes

A changeset file will be created in .changeset/. Commit this file with your changes.

When to add a changeset:

  • ✅ New features
  • ✅ Bug fixes
  • ✅ API changes
  • ✅ Performance improvements
  • ✅ Dependency updates that affect users

When NOT to add a changeset:

  • ❌ Documentation-only changes
  • ❌ Internal refactoring (no user-facing changes)
  • ❌ Test updates
  • ❌ CI/CD changes
  • ❌ Example app changes

The CI will automatically check that a changeset is present when needed.

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.

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.

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:

pnpm release

Scripts

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

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