nsmsn / burnout.io

Burnout.io is a site that provides resources to prevent work-related burnout.

Burnout.io provides resources to prevent IT burnout.

Contributing

We value your ideas! If you'd like to help improve Burnout.io, do whatever works best for you:

• Open an issue,
• Fork the project and submit a PR,
• Send an email, or
• Reach out on twitter.

###Things you should know:

• This project is written in reStructuredText
• Hosted by Read the Docs
• Tested by rendering in Sphinx on Travis CI

This is the only Markdown file in the repository, as it's not meant to be included in the documentation itself.

If you are looking to add content, fix formatting, syntax, typos or other wonderful things, please follow this process:

• Install Sphinx: easy_install Sphinx sphinx_rtd_theme or pip install -r requirements.txt
• Fork the repository to your own account
• 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.