Skip to content

Commit c899b76

Browse files
committed
doc: futher guidelines for registering a plugin
1 parent 0962489 commit c899b76

1 file changed

Lines changed: 22 additions & 1 deletion

File tree

help/registering/index.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,28 @@ editing it accordingly.
99

1010
---
1111

12-
**Before registering your plugin, please check the following:**
12+
**Before registering your plugin, please consider whether you are actually willing and able to *actively* maintain it.**
13+
14+
This means you will be around after registration too, keep up with changes in OctoPrint's plugin API and adjust your plugin as necessary
15+
in new releases, fix bugs that are reported to you by the community, fix *security issues* reported to you and maybe also implement the
16+
one or other feature request.
17+
18+
You should *not* register a plugin just to make it easier for you to install it. We expect plugins on
19+
the official repository to be actively maintained. That doesn't necessarily mean a lot of work, it very much depends on the complexity
20+
and size of your plugin. But you should be clear that **publishing your plugin on the official repository means it becomes your responsibility**
21+
-- and, when you no longer can take care of it, notifying us and ideally also helping find someone else who can continue your work is also
22+
something you should consider your responsibility as a plugin maintainer.
23+
24+
This *also* means that you should be capable of fixing issues in your plugin even if your favourite genAI is down,
25+
and that you understand why your plugin works in the first place -- meaning that **completely vibe coded plugins
26+
are *not* something we will accept here**.
27+
28+
**tl;dr: By publishing a plugin on the official OctoPrint Plugin Repository, you become responsible of
29+
properly maintaining it. Be sure you are both willing and able to do this *before* you register your plugin.**
30+
31+
---
32+
33+
Once you are clear on whether you want to and can maintain your plugin, also check the following.
1334

1435
* Your plugin doesn't have any additional code in its <code>setup.py</code> that would run directly on
1536
plugin installation, or any additional code in its <code>__init__.py</code> that would run outside of

0 commit comments

Comments
 (0)