Contributing¶

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 plasma-js-lib, 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 contributing@plasma.group.

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 plasma-js-lib, 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 Repository¶

First, clone the plasma-js-lib GitHub repository and enter the directory:

Node.js¶

plasma-js-lib is a Node.js application. You’ll need to install Node.js (and it’s corresponding package manager, npm) for your system before continuing.

Packages¶

plasma-js-lib makes use of several npm packages.

Install all required packages with:

Running Tests¶

plasma-js-lib makes use of a combination of Mocha (a testing framework) and Chai (an assertion library) for testing.

Run all tests with:

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.