Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Preparing for Tripal Badge Request #48

Open
laceysanderson opened this issue Oct 7, 2020 · 0 comments
Open

Preparing for Tripal Badge Request #48

laceysanderson opened this issue Oct 7, 2020 · 0 comments

Comments

@laceysanderson
Copy link
Member

laceysanderson commented Oct 7, 2020

Documentation

Description

This issue is in preparation for request for a gold Tripal extension module badge.
https://github.com/UofS-Pulse-Binfo/genotypes_loader

Bronze

Requirement Status
Has a public release. Yes
Should install on a Tripal site appropriate for the versions it supports. Yes, tested by TravisCI
Defines any custom tables or materialized views in the install file (if applicable). Yes
Adds any needed controlled vocabulary terms in the install file (Tripal3). Yes
Provides Installation and admin instructions README.md (or RTD). Yes, Readme and RTD
Has a license (distributed with module). Yes

Silver

Requirement Status
Follows basic Drupal Coding standards; specifically, code format and API documentation. Yes
Uses Tripal API functions. Specifically, it should use the Chado Query API for querying chado (if using chado as the storage system). Yes
Tripal Jobs API for long running processes. Yes
TripalField class to add data to pages (Tripal3). NA, doesn't display data
Provides ways to customize the module (e.g. drush options, field/formatter settings, admin UI). Yes
Latest releases should follow Drupal naming best practices. e.g. first release for Drupal 7 should be: 7.x-1.x. Yes

Gold

Requirement Status
Extensive documentation for the module (similar to Tripal User’s Guide). Yes, RTD
Unit testing is implemented using PHPUnit with the TripalTestSuite or something similar. Yes
Continuous integration is setup (e.g. such as with TravisCI). Yes
Imports data via Tripal’s importer class (Tripal3). No, doesn't make sense for large scale genotypic data.
Tripal 3 fields are Fully compatible with web services. NA, no tripal fields
The elementInfo function is fully implemented. NA, no tripal fields
The query and queryOrder functions fully implemented. NA, no tripal fields
Web Services uses Tripal’s Web Service Classes (Tripal3). NA, no web services
Code sniffing and testing coverage reports (optional but encouraged). Yes
Drupal.org vetted release (optional but encouraged).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant