Evaluate module standards for tripal core

[bradfordcondon]

see:
statonlab/hardwoods_site#469

What needs to be done fro this module for gold standards?

• This is mostly fields so unit testing is hard.
• License
• releases
• Do any of the fields need to be customizable?
• Query, QueryOrder, elementInfo, web services...

[bradfordcondon]

Tripal module ranking system checklist

Bronze

• Has a public release that follows Drupal release naming rules.
• Should install on a Tripal site appropriate for the versions it supports.
• Defines any custom tables or mviews in the install file (if applicable).
• Provides Installation and admin instructions README.md (or RTD)
• Has a license (distributed with module)
• Adds any needed controlled vocabulary terms in the install file (if applicable)

Silver

• Follows Drupal code standards (how to measure this?)
• Use tripal API functions (is this too generic)?
• Uses the Chado API: Queries Chado using chado_generate_var, chado_expand_var, the ChadoRecord class or chado_xxx_record functions (except for complicated queries).
• Provides an admin interface to allow for customization

Tripal V3 specific:

• Uses the TripalField class to add data to pages (if applicable).

Gold

• Unit testing is implemented using PHPUnit with the TripalTestSuite or something similar.
• Continuous integrating is setup (e.g. such as with TravisCI).
  • Required: execution of unit tests
  • Optional (but encouraged): code sniffing and testing coverage reports.
• Project should have a public development branch (following Drupal naming rules) to encourage collaboration and pull requests.
• Extensive documentation for the module (similar to Tripal User's Guide).

Tripal V3 specific

• Imports data via Tripal's importer class
• Tripal 3 fields are
  • Fully compatible with web services
  • The elementInfo function is fully implemented.
  • query and queryOrder functions fully implemented.
• Web Services uses Tripal's Web Service Classes.

[bradfordcondon]

so whats missing:

• Drupal naming on branches/releases.
• double check all cvterms are added in the install.
  • the sequence features terms are WIP so might not be present...
• Unit testing . (too hard for fields!)
• T3 fields need web services, elementinfo, query, etc implemented