module_rating.rst 3.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. Tripal Module Rating System
  2. ===========================
  3. This module rating system is meant to aid Tripal Site Administrators in choosing extension modules for their site. It is also meant to guide developers in module best practices and celebrate modules which achieve these goals.
  4. Bronze
  5. ------
  6. .. image:: Tripal-Bronze.png
  7. - Has a public release.
  8. - Should install on a Tripal site appropriate for the versions it supports.
  9. - Defines any custom tables or materialized views in the install file (if applicable).
  10. - Adds any needed controlled vocabulary terms in the install file (Tripal3).
  11. - Provides Installation and admin instructions README.md (or `RTD <https://tripal.readthedocs.io/en/latest/dev_guide/rtd.html>`_).
  12. - Has a license (distributed with module).
  13. Silver
  14. ------
  15. .. image:: Tripal-Silver.png
  16. - Follows basic Drupal Coding standards; specifically, `code format <https://www.drupal.org/docs/develop/standards/coding-standards>`_ and `API documentation <https://www.drupal.org/docs/develop/standards/api-documentation-and-comment-standards#drupal>`_.
  17. - Uses Tripal API functions. Specifically, it should use the
  18. - Chado Query API for querying Chado (if using Chado as the storage system). (`API <http://api.tripal.info/api/tripal/tripal_chado%21api%21tripal_chado.query.api.inc/group/tripal_chado_query_api/3.x>`_, :doc:`Tutorial <../dev_guide/chado>`)
  19. - Tripal Jobs API for long running processes. (`API <http://api.tripal.info/api/tripal/tripal%21api%21tripal.jobs.api.inc/group/tripal_jobs_api/3.x>`_)
  20. - TripalField class to add data to pages (Tripal3). (:doc:`Tutorial <../dev_guide/custom_field>`)
  21. - Provides ways to customize the module (e.g. drush options, field/formatter settings, admin UI).
  22. - Latest releases should follow Drupal naming best practices.
  23. - e.g. first release for Drupal 7 should be: ``7.x-1.0``.
  24. Gold
  25. ----
  26. .. image:: Tripal-Gold.png
  27. - Extensive documentation for the module (similar to Tripal User's Guide). ( `Tutorial <https://tripal.readthedocs.io/en/latest/dev_guide/rtd.html>`_)
  28. - Unit testing is implemented using PHPUnit with the TripalTestSuite or something similar.
  29. - Continuous integration is setup (e.g. such as with TravisCI).
  30. - Imports data via Tripal's importer class (Tripal3) (:doc:`Tutorial <../dev_guide/custom_data_loader>`).
  31. - Tripal 3 fields are (:doc:`Tutorial <../dev_guide/custom_field/manual_field_creation>`)
  32. - Fully compatible with web services.
  33. - The elementInfo function is fully implemented.
  34. - The query and queryOrder functions fully implemented.
  35. - Web Services uses Tripal's Web Service Classes (Tripal3). (:doc:`Tutorial <../dev_guide/custom_web_services>`)
  36. - Code sniffing and testing coverage reports (optional but encouraged).
  37. - Drupal.org vetted release (optional but encouraged).
  38. Rate your Extension Module!
  39. -----------------------------
  40. We encourage Tripal module developers to rate their modules. This can be done by :doc:`./instructions`
  41. The following badges are for inclusion on your module README and documentation; however, they are only valid if your module has been included in :doc:`../extensions` with the given rating.
  42. reStructuredText
  43. .. code-block:: RST
  44. .. image:: https://tripal.readthedocs.io/en/7.x-3.x/_images/Tripal-Bronze.png
  45. :target: https://tripal.readthedocs.io/en/7.x-3.x/extensions/module_rating.html#Bronze
  46. :alt: Tripal Rating: Bronze
  47. Markdown
  48. .. code-block:: MD
  49. [![Tripal Rating Bronze Status](https://tripal.readthedocs.io/en/7.x-3.x/_images/Tripal-Bronze.png)](https://tripal.readthedocs.io/en/7.x-3.x/extensions/module_rating.html#Bronze)
  50. HTML
  51. .. code-block:: html
  52. <a href='https://tripal.readthedocs.io/en/7.x-3.x/extensions/module_rating.html#Bronze'>
  53. <img src='https://tripal.readthedocs.io/en/7.x-3.x/_images/Tripal-Bronze.png' alt='Tripal Rating: Bronze' />
  54. </a>
  55. .. note::
  56. Replace all instances of ``Bronze`` with either ``Silver`` or ``Gold`` for those badges.