Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
52 lines (39 sloc) 1.85 KB

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

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 html to build the docs in to _build/
  • Make your changes
  • Execute make html again 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.

Current Build Status

Documentation Status

travis_build_status

You can’t perform that action at this time.