How to Contribute

Contributing to Code

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

After cloning and building the repo, check out the issues list.

Build and Run

If you want to understand how EthQL works or want to debug an issue, you'll want to get the source, build it, and run EthQL locally.

Getting the sources

git clone https://github.com/ConsenSys/ethql.git

Prerequisites

• Git
• Node.JS
• Yarn, follow the installation guide
• GraphQL
• TypeScript
• Lodash
• Express
• Infura
• JSON RPC
• web3

Build

Run

Debugging

Automated Testing

Linting

We use tslint for linting our sources. You can run tslint across the sources by calling yarn run lint from a terminal or command prompt.

Work Branches

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.

Pull Requests

Suggestions

We're also interested in your feedback for the future of EthQL. You can submit a suggestion or feature request through the issue tracker. To make this process more effective, we're asking that these include more information to help define them more clearly.

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. Please read Contributor Code of Conduct.