How to contribute

Being an open source project means any help offered will be greatly appreciated, below is a quick run through of how you can help

Getting Started

  • Fork the latest branch of the component you want to contribute to
  • Make sure you have a GitHub account
  • use virtualenv to install all requirements from the requirements.txt file
  • fix the issue you \ add a feature
  • create a pull request

Documentation

Nebula docs are hosted at readthedocs , reading them is highly recommended prior to making any pull requests

What you can help with

  • documentation - everyone hates them but without them would you be able to figure out how to use Nebula?
  • bug fixes - need I say more?
  • submitting tickets - even if you don't have the time\knowledge to fix a bug just opening a github issue about it will greatly help
  • suggesting improvements
  • doing anything off the wishlist
  • spreading the word

Summary

  • Your awesome for helping, thanks.

P.S. don't forget to add yourself to to CONTRIBUTORS file.