Contributing to @pigi

Welcome! A huge thank you for your interest in contributing to Plasma Group. Plasma Group is an open source initiative developing a simple and well designed plasma implementation. If you’re looking to contribute to a Plasma Group project, you’re in the right place! It’s contributors like you that make open source projects work, we really couldn’t do it without you.

We don’t just need people who can contribute code. We need people who can run this code for themselves and break it. We need people who can report bugs, request new features, and leave helpful comments. We need you!

We’re always available to answer your questions and to help you become a contributor! You can reach out to any of the members of Plasma Group on GitHub, or send us an email at

Here at Plasma Group we’re trying to foster an inclusive, welcoming, and accessible open source ecosystem. The best open source projects are those that make contributing an easy and rewarding experience. We’re trying to follow those best practices by maintaining a series of resources for contributors to Plasma Group repositories.

If you’re a new contributor to @pigi/core, please read through the following information. These resources will help you get started and will help you better understand what we’re building.

Contributing Guide and Code of Conduct

Plasma Group follows a Contributing Guide and Code of Conduct adapted slightly from the Contributor Covenant. All contributors are expected to read through this guide. We’re here to cultivate a welcoming and inclusive contributing environment. Every new contributor needs to do their part to uphold our community standards.

Getting Started as a Contributor

Requirements and Setup

Cloning the Repo

Before you start working on a Plasma Group project, you’ll need to clone our GitHub repository:

git clone

Now, enter the repository.

cd pigi


Most of the Plasma Group projects are Node.js applications. You’ll need to install Node.js for your system before continuing. We’ve provided a detailed explanation of now to install Node.js on Windows, Mac, and Linux.


We’re using a package manager called Yarn. You’ll need to install Yarn before continuing.

Installing Dependencies

@pigi projects make use of several external packages.

Install all required packages with:

yarn install


@pigi provides convenient tooling for building a package or set of packages.

Build all packages:

yarn run build

Build a specific package or set of packages:

PKGS=your,packages,here yarn run build


Clean code is the best code, so we’ve provided tools to automatically lint your projects.

Lint all packages:

yarn run lint

Lint a specific package or set of packages:

PKGS=your,packages,here yarn run lint

We’ve also provided tools to make it possible to automatically fix any linting issues. It’s much easier than trying to fix issues manually.

Fix all packages:

yarn run fix

Fix a specific package or set of packages:

PKGS=your,packages,here yarn run fix

Running Tests

@pigi projects usually makes use of a combination of Mocha (a testing framework) and Chai (an assertion library) for testing.

Run all tests:

yarn test

Run tests for a specific package or set of packages:

PKGS=your,packages,here yarn test

Contributors: remember to run tests before submitting a pull request! Code with passing tests makes life easier for everyone and means your contribution can get pulled into this project faster.