rseng-citation-metadata

Solid

Covers making research software citable and contributors credited: writing CITATION.cff, describing software with CodeMeta (codemeta.json), minting DOIs and ORCIDs, and tracking contributors of every kind. Use when the user asks how to make software citable, add CITATION.cff or codemeta.json, obtain a DOI, ensure contributors get credit, or mentions CFF, CodeMeta, ORCID, CRediT or persistent identifiers. Use PROACTIVELY when generated code draws on a publication, website or existing code (credit it at the code site and in the references), at release preparation, and when citation files are edited. (Verifying references you cite: rseng-citation-hygiene; versioning schemes and the DOI-minting release: rseng-publishing-releasing.)

Data & Documents 14 stars 2 forks Updated 4 days ago MIT

Install

View on GitHub

Quality Score: 83/100

Stars 20%
39
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Making research software citable and credited Use this skill when someone wants their research software to be cited, discovered, and formally recognised: adding a citation file, writing machine-readable metadata, getting a persistent identifier, or building an evidence base of who contributed. Software has no title page, so the information needed to cite it is often hard to find - a citation file and structured metadata are what let both humans and tools cite the exact work correctly. Advise concrete files in the repository root, not abstractions. ## Start here: what a citable project needs For most projects, recommend all four in the repository root: 1. `CITATION.cff` - machine-readable citation metadata. 2. `codemeta.json` - richer discovery/interoperability metadata. 3. A DOI from an archive like Zenodo, minted per release. 4. A `CONTRIBUTORS` file - human-readable team record alongside the machine-readable ones. A software citation itself should carry: title, the specific version used, authors/creators, a DOI or other stable link, and the repository URL - the version matters for reproducibility. ## Write a CITATION.cff file The Citation File Format is a structured plaintext (YAML) format; a valid `CITATION.cff` in the repo root is reused automatically by GitHub, Zenodo, and Zotero. Do not hand-craft the syntax from memory - point the user at the CFFINIT generator, or start from the official example and validate with cffconvert. Checklist of core fields to pop...

Details

Author
fdiblen
Repository
fdiblen/rseng-agent-skills
Created
4 days ago
Last Updated
4 days ago
Language
Python
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category

Data & Documents Solid

rseng-citation-hygiene

Covers verifying that every citation is real, correct and current: checking references in manuscripts, READMEs, references files and code metadata against Crossref and OpenAlex, screening cited DOIs against the Retraction Watch database, catching fabricated or mis-attributed citations (a documented AI failure mode), and keeping bibliographies and CITATION.cff files resolvable. Use PROACTIVELY before any bibliography, reference list or citation metadata is finalized or published, whenever the agent itself has produced citations, and when the user asks to check references, mentions broken DOIs, retracted papers or citation verification, or prepares a manuscript, README or software paper with references. (Making your own software citable is rseng-citation-metadata.)

14 Updated 4 days ago
fdiblen
Data & Documents Solid

rseng-documentation

Covers how to document research software at every level: writing a README, code-level docs (comments, docstrings, API and CLI help), project docs (INSTALL, CONTRIBUTING, LICENSE, CITATION, changelog), publishing hosted documentation with Read the Docs, and capturing a Research Software Story. Use when the user asks how to write or improve a README, decide what documentation their project needs, add docstrings or inline comments, document an API or CLI, set up Sphinx/MkDocs/Doxygen, host docs on Read the Docs, structure a docs site, or write the narrative context and history behind a project. For outward-facing papers, talks and announcements see rseng-science-communication; for public and citizen-science narrative see rseng-storytelling.

14 Updated 4 days ago
fdiblen
AI & Automation Solid

rseng-fair-software

Covers how to apply the FAIR principles - findable, accessible, interoperable, reusable - to research software, and how to assess a project's FAIRness. Use when the user asks how to make software FAIR, wants help with findability, discoverability, or software reuse, mentions metadata, persistent identifiers, DOIs, registries, or software citation in a FAIR context, or asks to run a FAIR self-assessment or checklist on a repository. (Automated FAIR4RS scoring, compliance levels and CI gates with the FAIRGuard tool are rseng-fairguard; FAIR for ML models and datasets is rseng-fair-ml; finding existing software to reuse is rseng-software-reuse.)

14 Updated 4 days ago
fdiblen