Skip to content

Commit

Permalink
Complete general recommendations layout
Browse files Browse the repository at this point in the history
  • Loading branch information
moranegg committed May 19, 2024
1 parent ffe7f6c commit 8ea1c53
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions chapters/1.General.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 8ea1c53

Please sign in to comment.