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 an issue \ add a feature
  • Create a pull request

Documentation

Nebula docs are hosted at readthedocs using MkDocs for their creation, 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 / feature requests - anything off github issues lists
  • 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
  • For larger tasks - 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.md file.