Citable Research Software Releases
Prepare research software for reproducible installation, accurate citation and authorized archival release.
Use this skill to turn research code into a release that another researcher can obtain, run and cite. Establish the repository, release commit, intended license, author list, target platform and smallest reproducible scientific example. Separate preparing release files from actually publishing an archive. ## Key Points - [Citation File Format](https://citation-file-format.github.io/) - [Zenodo GitHub archiving](https://help.zenodo.org/docs/github/) - [Zenodo software metadata precedence](https://help.zenodo.org/docs/github/describe-software/)
skilldb get science-academia-skills/publish-research-softwareFull skill: 35 linesCitable Research Software Releases
Use this skill to turn research code into a release that another researcher can obtain, run and cite. Establish the repository, release commit, intended license, author list, target platform and smallest reproducible scientific example. Separate preparing release files from actually publishing an archive.
Establish the release boundary
List code, generated artifacts, test data, models and third-party components. Confirm redistribution rights for each. A source-code license does not automatically cover datasets or model weights. Replace confidential examples with synthetic fixtures and document retrieval of externally hosted inputs.
Record the exact commit and dependency lock or environment specification. State supported operating systems and any compiler, accelerator or system-library requirements. Avoid claiming broad portability from one machine. Make the README lead with installation, one runnable example, expected output and known limitations.
Make citation accurate
Create a CITATION.cff file using the supported schema. Verify contributor spelling, affiliations where used, ORCID identifiers supplied by their owners, software title, release version and date. Distinguish citation of the software from citation of an associated article. A preferred article citation must not erase the identity of the software used.
Validate metadata with a CFF-aware validator. Never invent a DOI or treat a reserved identifier as a completed public deposit. If archiving through Zenodo, inspect the current repository integration and release behavior before enabling it. The GitHub integration uses .zenodo.json instead of CITATION.cff for deposited metadata when both are present. Validate and compare the effective archive metadata against the intended version and authors. Record the distinction between a specific version identifier and an identifier representing the evolving software concept.
Reproduce before release
Test from a clean checkout at the intended tag. Install from the artifact a user will receive, not just the development tree. Run the smallest example with no implicit home-directory files or unpublished packages. Compare scientific output against a documented analytical result, reference fixture or justified numerical tolerance.
Inspect the built archive contents. Exclude credentials, private notebooks, large unintended caches and temporary output. Verify that the license, citation file and usage instructions are included. Create checksums for distributed artifacts and preserve the test environment record.
Prepare release notes describing scientific or interface changes and any changed interpretation of earlier results. Obtain the publication authority required by the project, then verify the actual archive record and downloadable files after publication. Deliver a release checklist with factual statuses; an assembled ZIP and a published, citable release are separate outcomes.
References
Install this skill directly: skilldb add science-academia-skills
Related Skills
Research Methodology
Research methodology specialist that helps researchers design rigorous studies, select appropriate methods, and navigate ethical review, covering quantitative, qualitative, and mixed-methods approaches across disciplines.
Science Outreach
Science outreach and public engagement specialist that helps researchers communicate their work to lay audiences, design outreach programs, handle media, leverage social media, and counter scientific misinformation effectively.
Thesis Dissertation
Thesis and dissertation writing specialist that guides graduate students through every stage from proposal to defense, covering committee management, chapter structure, literature review strategies, time management, and publishing from the dissertation.
Academic Paper Writing
Academic paper writing specialist that guides researchers through every stage of manuscript preparation, from structuring an IMRaD paper to responding to peer review, with attention to journal-specific conventions and common rejection pitfalls.
Data Visualization Science
Scientific data visualization specialist that helps researchers create accurate, accessible, and publication-ready figures using best practices in chart selection, color theory, and tools like matplotlib, ggplot2, and D3.
Grant Writing
Research grant writing specialist that helps researchers craft competitive proposals for NIH, NSF, EU, and other funding bodies, covering every section from specific aims to budget justification and resubmission strategy.