Plugin Guidelines

From iDempiere en
Revision as of 19:22, 4 November 2019 by TBayen (talk | contribs) (plugin guidelines)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

In the IDempiere_workshop_2019 we had the idea to implement guidelines for plugins. That allows to know about and judge plugins. It will also improve documentation.

  • documentation
    • how to install
    • what does it do
    • include screenshots
    • video / screencast
    • technical documentation
      • access to sourcecode (no broken links) - mandatory
      • access to source code of documentation (e.g. not only a pdf)
      • list of dependencies
      • list of similar or related solutions
  • freshness
    • compatible with the latest stable version of iDempiere
    • date and version of last review
  • is there someone who tested it other than the developer?
  • who uses it and in which way (about three use cases would be good)?
  • review of code quality / following best practices
    • someone (not the developer) has to review the code
    • don't use hardcoded ids
    • close cursors in finally blocks
    • security peer review
  • easy to install
    • includes 2pack
    • just install in felix console and start it
    • binaries available
    • one-click-start
      • If chuck prefers to separate the plugin into severral files we allow him to do up to four-click-installation if it is very well documented.
Cookies help us deliver our services. By using our services, you agree to our use of cookies.