Credit & attribution

Objective

To ensure proper crediting and acknowledgment of software creators, authors, and contributors, it is important to follow citation recommendations.

Recommendations

RSMD-5.1

Essential ☆☆☆

Add intrinsic metadata about authors, this information can be captured in a human readable format( AUTHORS file, as a section in README, CONTRIBUTORS.md etc.) or in an author's property in a machine-readable format (e.g codemeta.json, package management file, etc.).

RSMD-5.2

Essential ☆☆☆

Add authors and contributors to the metadata record.

RSMD-5.3

Important ☆☆

Use people identifiers for non-ambiguous attribution (ORCID, ID-HAL, ID-REF, GPG key, VIAF, ISNI etc.)

RSMD-5.4

Important ☆☆

Use roles for software actors (authors & contributors). Refer to existing contributor roles if possible:

• https://allcontributors.org/
• CRediT – Contributor Roles Taxonomy (niso.org)
• SORTÆD: Software Role Taxonomy and Authorship Definition
• https://w3id.org/softwareCredit

RSMD-5.5

Important ☆☆

Provide citation preference (CITATION.cff file, Citation section in README, .bib file, etc.)

RSMD-5.6

Useful ☆ Where applicable, use appropriate citation granularity level (software, software-module, software-version, code-fragment) by referring to the BibLaTeX software package specifications.

See:

• https://ctan.org/pkg/biblatex-software;
• https://fr.overleaf.com/learn/latex/Bibliography_management_with_biblatex

RSMD-5.7

Useful ☆

In case of plurality of authors, identify all the owners : the authors list should be exhaustive to ensure credit. Note: in some cases it might be impossible to have an exhaustive list of authors, in this case a collective author may be used.