How to Contribute

Contributing to Cypherblock

There are many ways to contribute to the Cypherblock project: logging bugs, submitting pull requests, reporting issues, and creating suggestions.

Prerequisites

You'll need the following tools to download and build Cypherblock locally:

• Git
• Node.JS, version >= 10.10.0
• Yarn, follow the installation guide
• VSCode (Recommened)
  • ESLint
  • Prettier - Code formatter

Setting Up a Development Environment

To prepare for contributing to Cypherblock project, you'll need to setup your own local development environment: Get the sources, build it, config some parameters, and run it locally.

Getting the sources

First, fork the Cypherblock repository so that you can make a pull request. Then, clone your fork locally:

git clone https://github.com/<<<your-github-account>>>/cypherblock-eos.git

Occassionally you will want to merge changes in the upstream repository (the official Cypherblock repo) with your fork.

cd cypherblock-eos
git checkout master
git pull https://github.com/Cypherman1/cypherblock-eos master

Manage any merge conflicts, commit them, and then commit them to your fork.

Build

Install and build all of the dependencies using Yarn:

cd cypherblock-eos
yarn

Configuring

Get a Coinmarketcap API Key

Locate the file ./src/server/config/dev.js and config the parameters:

module.exports = {
  chainURL: 'https://eos.greymass.com',//Change to your favorite BP API end point
  chainURL_ALT1: 'https://mainnet.eoscanada.com',//Change to your favorite BP API end point
  historyURL: 'https://eos.greymass.com',//Change to your favorite BP API end point
  mongoHistoryURL: 'https://history.cryptolions.io',
  cmcAPIKey: '18edf1e2-6d7d-4c5a-82fe-bde94fc02e61' //Change to your own Coinmarketcap API Key
};

Run

To start the development server, run:

yarn dev

Give a minute for the server to start and go to http://localhost:3000

Contributing

Now, It's time to write your code and contribute to Cypherblock repo

Work Branches

Before writing your code, you should create a personal fork and create feature branches there when you need them. This keeps the main repository clean and your personal workflow cruft out of sight.

git checkout -b your_branch_name

Write your code

Pull Requests

Merge changes in the upstream repository (the official Cypherblock repo) with your local clone off your fork

git checkout master
git pull https://github.com/Cypherman1/cypherblock-eos master

Merge your branches to master, manage any merge conflicts, commit them, push to your fork and create the pull request.

Discussion Etiquette

In order to keep the conversation clear and transparent, please limit discussion to English and keep things on topic with the issue. Be considerate to others and try to be courteous and professional at all times.