Contribute¶
We value your ideas! If you’d like to help improve Burnout.io, do whatever works best for you:
Info for Contributing to Burnout.io¶
- This project is written in reStructuredText and Markdown
- Hosted by Read the Docs
- Tested by rendering in Sphinx on Travis CI
If you are looking to add content, fix formatting, syntax, typos or other wonderful things, please follow this process:
- Clone the project
- Install Sphinx:
pip install -r requirements.txt - Check out a branch to make your changes on:
git checkout --branch <my_topic> - Execute
make htmlto build the docs in to_build/ - Make your changes
- Execute
make htmlagain and verify your changes don’t cause any warnings/errors - Commit with a descriptive message, and submit a pull request from your branch to
master - We’ll review the change, and either merge it or provide some feedback. Community review is also encouraged.
travis_build_status