Skip to content

feedBack plugin specification

The specification and best-practices guide for building plugins for feedBack. A plugin is a self-contained folder — described entirely by its plugin.json manifest — that extends feedBack with a screen, a settings panel, server routes, and/or a declared capability.

Read the specification Best-practices guide

Documents

  • Specification — the authoritative, normative reference: the manifest, discovery and loading, the client and server surfaces, capabilities, and versioning.
  • Best-practices guide — non-normative advice for building good plugins.
  • Changelog — version history.

Machine-readable schema

JSON Schema (Draft 2020-12) for the manifest — the resolvable counterpart of the manifest reference:

Worked examples

  • examples/minimal-plugin — the smallest thing that loads (manifest only).
  • examples/full-plugin — every surface: screen, styles, settings, routes, capabilities.

Validate any plugin against the schema and the structural rules:

pip install jsonschema
python tools/validate.py path/to/my-plugin

License

This repository is licensed under AGPL-3.0-only, consistent with the feedBack application and server.