Skip to content

Latest commit

 

History

History
78 lines (53 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

78 lines (53 loc) · 1.24 KB
Raw

Contributing Guidelines

🐬 Thanks for being interested in contributing to Orchestrate! People will ❤️ you for that. 👍

Create dev environment

Prerequisite

Orchestrate requires

  • Go 1.16
  • docker & docker-compose

Installation

To contribute

  1. Clone project locally
$ git clone git@github.com:ConsenSys/orchestrate.git <project_name> 
$ cd <project_name>

Running local development environment

  1. Start Orchestrate development
$ make dev

To start different test network you can run:

  1. For geth client
$ make geth
  1. For Besu client
$ make besu
  1. For go-quorum client
$ make go-quorum

Testing

  1. Run linting checks
$ make lint
  1. Run unit tests
$ make coverage
  1. Run integration tests
$ make run-integration
  1. Run end to end test suite
$ cp .env.ci .env
$ make e2e

Git Branching Strategy

alt git-branching-strategy

For more details about git branching strategy refer to Git branching Strategy