plugins: Document usage of semver

fkie-cad · Jul 13, 2023 · 2dd7b7c · 2dd7b7c
1 parent a01c26d
commit 2dd7b7c
Showing 1 changed file with 8 additions and 2 deletions.
diff --git a/src/analysis/plugin/plugin.py b/src/analysis/plugin/plugin.py
@@ -49,8 +49,14 @@ class Config:
         # Note that we cannot allow pydantic dataclasses because they lack the `schema` method
         Schema: typing.Type
         #: The version of the plugin.
-        #: MUST adhere to PEP 440.
-        #: We suggest using a semver compatible version.
+        #: It MUST be a `semver <https://semver.org/>`_ version.
+        #: Here is a quick summary how semver relates to plugins.
+        #: * MAJOR: The plugin schema changed.
+        #: * MINOR: The schema din't change but might contain more data.
+        #: * PATCH: A bug was fixed e.g. a crash on some files.
+        #:
+        #: Note that any version change leads to rescheduling the analysis.
+        #: But backwards compatible results will still be shown in the fronfrontend.
         version: semver.Version
         #: The version of the backing analysis system.
         #: E.g. for yara plugins this would be the yara version.