Welcome to the BitBox contributing page! We're super excited you've taken an interest in this project. Also check out CoinTK, the strategy development and backtesting framework BitBox is built on, and BitBox iOS, the accompanying iOS app for the BitBox server.
- Take a look at our todo list
- Browse through (and shoot down) some bugs
- Shoot an email to
agajews@gmail.comto get added to the cointk.slack.com channel
TBD
Make sure you're running Python 3.3+, as some of the dynamic module loading requires relatively new features.
- Fork this repo and clone it to your local machine
- Make your changes, fix your bugs, etc.
- Commit your changes
- Submit a pull request to this repository for your new commit
- Discuss your changes with core devs below your pull request
- Watch your change be accepted into this repo!
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
First bugs for contributors
- When we start finding bugs, we'll add something here!
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 BitBox could fly airplanes and blast music at strangers, we'd like to know why you want BitBox to do these things.
Try to follow PEP8, and please use a linter. Pull requests that are not properly linted will be rejected until that has been fixed.
Please be courteous to others and thoughtful before sharing potentially hurtful opinions.
At the start of each new release of BitBox, all contributors who submitted accepted pull requests to this repository will be recognized in a CONTRIBUTORS.md file.
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.