Difference between revisions of "Best practices"
From Earth Science Information Partners (ESIP)
| Line 9: | Line 9: | ||
==Publishing software== | ==Publishing software== | ||
| − | Best practice recommendations for publishing software | + | Best practice recommendations for publishing software. |
===IMCR Portal=== | ===IMCR Portal=== | ||
| − | + | Considerations for publishing in the IMCR Portal. | |
====Using the controlled vocabulary==== | ====Using the controlled vocabulary==== | ||
| Line 18: | Line 18: | ||
===Project repository=== | ===Project repository=== | ||
| + | Considerations for features to include in the project repository. | ||
====README==== | ====README==== | ||
| + | README are essential for orienting the user to what the project addresses. | ||
====Vignette==== | ====Vignette==== | ||
| + | Vignettes are useful for demonstrating the projects functionality. | ||
====DOI==== | ====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. | ||
| + | * [https://zenodo.org Zenodo] | ||
| + | * [https://guides.github.com/activities/citable-code/ Interfacing GitHub and Zenodo] | ||
| + | |||
====Test data==== | ====Test data==== | ||
Revision as of 11:36, 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.
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.
