Skip to content
This repository was archived by the owner on Jan 8, 2026. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
89 lines (57 loc) · 2.44 KB

CONTRIBUTING.md

File metadata and controls

89 lines (57 loc) · 2.44 KB

Contributing to Immutable X Examples

Welcome to Immutable X! This repository is designed to empower developers to integrate with Immutable X quickly and effectively.

This contributing guide will help you get started with the repository and start contributing to the code.

Table Of Contents

What should you contribute?

You are welcome to contribute any fix or feature you can think of!. If you would like ideas, however, please refer to TODO.md.

Prerequisites

The following dependencies are required before running the bootstrap procedure outlined below.

  • Node.js >= 12
  • NPM >= 7

Bootstrap

To get started, clone this repo and install all dependencies.

clone git@github.com:immutable/imx-examples.git
cd imx-examples
npm install

Linting

The linting procedure checks the entire package source code using (in order):

  • typescript typecheck
  • eslint
npm run lint:eslint:fix

Building

The following will build the package for production to the dist folder using tsc:

npm run build

Publish your changes

After you have verified your changes locally, you are ready to push your changes to the remote repo!

Commit Conventions

Please follow the Conventional Commits guidelines when creating commits.

Make a Pull Request

The first step is to create a branch that will be the basis of a pull request. It is recommended you start your branch from an up-to-date version of main. However, you can run the following from any branch you may have been developing on:

git checkout -b feat/magic
git pull --rebase origin main
git push origin feat/magic

Your branches should be named in the following manner:

  • feat/xyz for new features
  • fix/xyz for bug fixes

After pushing your branch, visit https://github.com/immutable/imx-examples and use the GitHub UI to create a pull request.

Pull Request Review

The maintainers of this repo will attempt to review your pull request when they are available.