-
Notifications
You must be signed in to change notification settings - Fork 6
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
There is no documentation on how to create a new indicator plugin. The README mentions the plugin architecture briefly, but someone who wants to add a new check has to reverse-engineer the existing plugins to figure that out.
A step-by-step guide with a skeleton example would lower the barrier to contribution significantly. Something like:
- Create a new file in
src/resqui/plugins/ - Subclass
IndicatorPlugin - Set the class attributes (name, version, id, indicators)
- Implement your indicator methods
- Register in
__init__.py - Add to configuration files
- Test it
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation