Difference between revisions of "Best practices"

From Earth Science Information Partners (ESIP)
Line 30: Line 30:
 
====Test data====
 
====Test data====
 
Test data facilitates experimentation and understanding of the projects functionality.
 
Test data facilitates experimentation and understanding of the projects functionality.
 +
====Tagging====
 +
Tagging the project repo with good keywords facilitates discovery. See the IMCR Controlled Vocabulary.

Revision as of 11:43, July 19, 2018

Return to IM Code Registry main page

Overview

Here are some best practice recommendations for software.

Development

Best practice recommendations for software development.

ESIP software assessment guidelines

Publishing software

Best practice recommendations for publishing software.

IMCR Portal

Considerations for publishing in the IMCR Portal.

Using the controlled vocabulary

The IMCR controlled vocabulary and how to use it.

Project repository

Considerations for features to include in the project repository.

README

README are essential for orienting the user to what the project addresses.

Vignette

Vignettes are useful for demonstrating the projects functionality.

DOI

Periodic releases of the project code can be accompanied by the minting of a DOI. GitHub supports archive in with generation of a DOI, thereby making the project citable.

Test data

Test data facilitates experimentation and understanding of the projects functionality.

Tagging

Tagging the project repo with good keywords facilitates discovery. See the IMCR Controlled Vocabulary.