Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (38 loc) · 2.54 KB

CONTRIBUTING.md

File metadata and controls

52 lines (38 loc) · 2.54 KB

Contibuting to Bitbox

Welcome to the Bitbox contributing page! We're super excited you've taken an interest in this project. See also, part of the CoinTK Initiative: BitBox-Server, a webserver built on CoinTK for backtesting and dry running prototype strategies (remote control coming soon!).

CoinTK, an open-sourced framework for rapid prototyping and testing of Bitcoin trading strategies. This is the foundation for everything.

Quickstart

  • Take a look at our todo list
  • Browse through (and shoot down) some bugs
  • Shoot an email to agajews@gmail.com to get added to the cointk.slack.com channel

Testing

TBD

Development environment details

Make sure you're running Python 3.3+, as some of the dynamic module loading requires relatively new features.

How to submit changes

  1. Fork this repo and clone it to your local machine
  2. Make your changes, fix your bugs, etc.
  3. Commit your changes
  4. Submit a pull request to this repository for your new commit
  5. Discuss your changes with core devs below your pull request
  6. Watch your change be accepted into this repo!

How to report a bug:

Make sure your bug reports include the following

  • Steps for reproducing bug
  • Expected result
  • Observed result
  • External Environment (What kind of operating system and (if necessary) hardware were you running when the bug occurred?)
  • Anything else you'd like to tell us

Bugfixing

First bugs for contributors

  • When we start finding bugs, we'll add something here!

New Feature Requirements

When proposing new features either on slack or as github issues, make sure to include an intended use case. Yes, it would be nice if CoinTK could fly airplanes and blast music at strangers, we'd like to know why you want CoinTK to do these things.

Style Guide / Coding conventions

Try to follow PEP8, and please use a linter. Pull requests that are not properly linted will be rejected until that has been fixed.

Code of Conduct

Please be courteous to others and thoughtful before sharing potentially hurtful opinions.

Recognition

At the start of each new release of CoinTK, all contributors who submitted accepted pull requests to this repository will be recognized in a CONTRIBUTORS.md file.

Where can I ask for help?

Ask for help on slack, in a github issue, or send any core dev an email (our addresses are in our profiles). We're always happy to answer any questions you may have.