Difference between revisions of "Plugin Criteria"

From MOD Wiki
Jump to navigation Jump to search
(Created page with "This page is for list of curation items MOD does on plugins before publishing them to the Plugin Store. Please note that, due to this list not being created from the start, a...")
 
Line 6: Line 6:
 
New plugins MUST follow these rules:
 
New plugins MUST follow these rules:
  
1. builds through mod-plugin-builder as a buildroot package (todo add doc links)
+
# builds through mod-plugin-builder as a buildroot package (todo add doc links)
2. has a modgui
+
# has a modgui
3. has at least 1 preset (the "default" one, matching default plugin values)
+
# has at least 1 preset (the "default" one, matching default plugin values)
4. has a comment/description on its meta-data
+
# has a comment/description on its meta-data
5. has a valid version
+
# has a valid version
6. has correct and consistent brand name (todo explain what it means, max characters, how to name individuals etc. For example "Guitarix" [not "Guitarix team"] and "F. Coelho" [not "Filipe C."])
+
# has correct and consistent brand name (todo explain what it means, max characters, how to name individuals etc. For example "Guitarix" [not "Guitarix team"] and "F. Coelho" [not "Filipe C."])
7. has on/off switch on its modgui
+
# has on/off switch on its modgui
8. has no memory errors or leaks (todo explain how to test)
+
# has no memory errors or leaks (todo explain how to test)

Revision as of 12:34, 3 August 2021

This page is for list of curation items MOD does on plugins before publishing them to the Plugin Store.

Please note that, due to this list not being created from the start, a few of the already published plugins do not check all boxes. An on-going effort to bring up the quality of all plugins already in the store is in place.

New plugins MUST follow these rules:

  1. builds through mod-plugin-builder as a buildroot package (todo add doc links)
  2. has a modgui
  3. has at least 1 preset (the "default" one, matching default plugin values)
  4. has a comment/description on its meta-data
  5. has a valid version
  6. has correct and consistent brand name (todo explain what it means, max characters, how to name individuals etc. For example "Guitarix" [not "Guitarix team"] and "F. Coelho" [not "Filipe C."])
  7. has on/off switch on its modgui
  8. has no memory errors or leaks (todo explain how to test)