Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (25 loc) · 3.13 KB

CONTRIBUTING.md

File metadata and controls

39 lines (25 loc) · 3.13 KB

Contribution And Starting Guide

Task Description
Upcoming Events High-priority event issues with planned completion dates.
Release Candidates Feature-complete versions linked to events.
Features & Bugs High-priority feature and bug issues.

How to contribute

We welcome contributions to this project. We manage active development via issues. You may either submit and issue for triage or begin working on something already in the backlog. In both cases, we recommend you follow the initial steps below:

  1. Identify upcoming Events: check for priority:urgent and priority:high issues tagged with event label here. These issues mark upcoming events with a planned date for completion and thus a focus of active development. The events will also be sequenced.
  2. Identify relevant release Candidates: one or more release candidates will be linked to an event as sub-issues. Release candidates will entail a feature complete version of the project with a planned date for completion. The date for completion may be after the event date if the event features rolling releases. You can check all release candidates here.
  3. Identify high-priority Features and Bugs: after you've selected your release candidate, review it's sub-issues for potential feature and bug requests. You check all priority:urgent and priority:high issues tagged with feature or bug label here.

New contributors should prioritize issues tagged with bug.

Experienced contributors should prioritize issues tagged with feature and facilitate the onboarding of new contributors to bug fixes.

Those looking to add to the suggest new features and bugs should identify whether their idea is suitable by considering the existing release candidates and their sub-issues.

Getting started

We develop in nix. Hence start by entering the nix shell:

nix develop

The easiest entry point for all protocols and use cases is the ffs-dev CLI. Subcomponents of ffs-dev will have their own CLIs and these CLIs have their core libraries.

For example, to spin up a network with Anvil, you can run the following command (after you build the ffs-dev binary):

./target/release/ffs-dev mcr network coordinator eth anvil up

For a more in-depth usage guide, see Usage of CLI.