Skip to content
This repository has been archived by the owner on Jan 31, 2023. It is now read-only.

Latest commit

 

History

History
18 lines (13 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

18 lines (13 loc) · 1.59 KB
Raw

How to Contribute

Types of plugins accepted

We are interested in general-use plugins that have the potential to be used on multiple channels. If you have an idea that is unique to your specific channel, it's unlikely to be accepted. If you are unsure, ask first (file an issue or via #lincolnloop on Freenode).

Also be sure your plugin meets Freenode's channel guidelines.

Plugin code requirements

  1. Written in Python (2.7.x)
  2. Closely follows PEP 8 guidelines
  3. Tested. See botbot_plugins/tests directory for examples.
  4. Each plugin is implemented as a single module in the botbot_plugins/plugins directory. The module should contain a single Plugin class that inherits from botbot_plugins.base.BasePlugin.
  5. The Plugin class' docstring should thoroughly describe its behavior to an end-user. It starts with a single line of text serving as a succinct (75 characters or less) summary. It will be formatted with Markdown and displayed as help text.
  6. Preferably no additional external dependencies. Use the standard lib or existing dependencies whenever possible.
  7. Submitted as a pull request via GitHub.
  8. Plugins have access to a Redis database for storage. For hopefully obvious reasons, not all Redis commands are available for use by plugins (FLUSHALL for example). Plugins must use the provided storage interface methods; this is also required so that the plugin system can maintain an association between a plugin and its data.