Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
145 lines (95 loc) · 5.83 KB

CONTRIBUTING.md

File metadata and controls

145 lines (95 loc) · 5.83 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 Yarn workspaces. It contains the following packages:

  • The library package in packages/inspector.
  • An example app in apps/example.

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.

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 apps/example/android or apps/example/ios directories respectively in those editors. To edit the Objective-C or Swift files, open apps/example/ios/InspectorExample.xcworkspace in Xcode and find the source files at Pods > Development Pods > inspector.

To edit the Java or Kotlin files, open apps/example/android in Android studio and find the source files at inspector under Android.

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

To start the packager:

yarn example start

To run the example app on Android:

yarn example android

To run the example app on iOS:

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

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

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.

Scripts

The root package.json file contains script delegates 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 changeset: create or update a Changeset for release notes and versioning.
  • 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.

Changesets workflow

Use Changesets to describe user-facing changes and prepare releases for the packages.

For contributors

  • Add a Changeset for pull requests that change the public API, native behavior, runtime behavior, or developer-facing usage.
  • You can usually skip a Changeset for changes that are purely internal, such as CI tweaks, refactors with no observable impact, or documentation-only updates.
  • Run the following command from the repository root:
yarn changeset
  • When prompted, select @callstack/inspector or @callstack/inspector-cli. Do not select the private example workspace.
  • Choose the appropriate bump level (patch, minor, or major) and write a short summary of the user-facing change.
  • Commit the generated file in .changeset/ with the rest of your pull request.

For maintainers

  • Pull requests merged to main with pending Changesets will cause the release workflow to open or update a Version Packages pull request.
  • Review that release pull request carefully because it contains the generated version bump and changelog updates that will be published.
  • After the Version Packages pull request is merged, the release workflow will build the package and publish it to npm automatically.

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.
  • Add a Changeset when the pull request introduces a user-facing change.
  • 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.