From 8ea1c53305231efeb7bfb2c735db8ec5f19cebde Mon Sep 17 00:00:00 2001 From: Morane Gruenpeter Date: Sun, 19 May 2024 23:07:33 +0000 Subject: [PATCH] Complete general recommendations layout --- chapters/1.General.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/chapters/1.General.md b/chapters/1.General.md index cfa58b6..5cd3416 100644 --- a/chapters/1.General.md +++ b/chapters/1.General.md @@ -3,3 +3,37 @@ ## Objective To ensure the collection, curation, and maintenance of research software metadata, the following general recommendations are suggested for end users, including researchers, software engineers, curators, and institution staff. +## Definitions +- **Intrinsic metadata** refers to information that is embedded within the content or object itself, in a metadata file that can be human readable (e.g README) or machine-actionable (e.g pom.xml, codemeta.json) +* **Extrinsic metadata** is the record describing the software externally to the source code. + +## Recommendations +### RSMD-1.1 +**Essential ☆☆☆** + +Provide embedded information about software in the code itself as a metadata file (intrinsic metadata) to ensure it is kept and maintained alongside the software. Can be applied to open and proprietary software. + + +### RSMD-1.2 +**Essential ☆☆☆** + +Issue a metadata record (extrinsic metadata) about the source code in a publicly available infrastructure to benefit from the infrastructure metadata service (such as citation exports and search functionalities): +* scholarly repository (e.g HAL, Zenodo, etc.) +* publisher (e.g IPOL, eLife, [Dagstuhl](https://www.dagstuhl.de/), etc.) +* registry/ aggregator (e.g ASCL, swMath, WikiData, DataCite, bio.tools, etc.) + + +### RSMD-1.3 +**Important ☆☆** + +Use a version control system to track changes in the source code development and facilitate archival. If an online platform is used, capture the URL in a **CodeRepository** property. + +### RSMD-1.4 +**Useful ☆** + +Follow community standards when developing software: An example can be language-specific standards and best practices (e.g. DESCRIPTION file in R, see also https://swcarpentry.github.io/r-novice-inflammation/08-making-packages-R.html). + +### RSMD-1.5 +**Useful ☆** + +Keep the machine readable intrinsic metadata information in a single source file, and automatically generate other file formats, to avoid misalignment and duplication (e.g. generate citation.cff from codemeta.json) wherever possible. \ No newline at end of file