Want to contribute?

There are many ways you can contribute:

• File bug reports.
• Implement new features.
• Build your own client.
• Write documentation.
• Write tests.
• Talk about Shiva.
  • Write an article.
  • Give a talk.
• Use it!

If you build a client or write an article about Shiva, let us know and we’ll include it in our documentation.

Sending code

If you want to implement a new feature or fix a bug, remember that every PR that you issue must:

• Strictly follow the PEP8.
• Include documentation, if applicable.
  • Detailed documentation of the new feature.
  • Update old documentation for functionality changes.
• Include tests.
• Not break previous tests.

The CI tool will check for most of this, so make sure the build passes.

Reporting bugs

Please report bugs, recommend enhancements or ask questions in our issue tracker. Before reporting bugs please make sure of the following:

• The bug was not previously reported.
• You have the latest version installed.
• The bug is not actually a feature.