Skip to content

CITATION-GUIDE.md

Latest commit

 

History

History
58 lines (40 loc) · 2.67 KB

CITATION-GUIDE.md

File metadata and controls

58 lines (40 loc) · 2.67 KB
Raw

Citation Guide

Languages: English | Português do Brasil | Italiano | Español | עברית | 日本語 | 简体中文

This guide explains how to cite this fork without erasing the original authorship of MiroFish.

What should be cited

The primary citable object in this repository is the archived release of this fork once Zenodo has minted a real DOI. Before that happens, the repository can expose GitHub citation metadata, but no final publication should cite an unminted DOI.

When to cite this citation edition

  • When your work used this multilingual editorial edition directly.
  • When reproducibility depends on the exact archived release of this fork.
  • When you want a stable DOI-backed software citation string.

When to mention or cite the upstream project

  • When discussing original authorship.
  • When discussing the original implementation or original innovation.
  • When comparing this citation edition to the upstream repository.

How to record the minted DOI after the first release

  • Create the GitHub release.
  • Enable the repository in Zenodo and archive the release.
  • For this release, the version DOI is 10.5281/zenodo.19189253.
  • Record the minted version DOI in the main-branch documentation and human-facing citation examples.
  • Do not create a second release only to bake the DOI into the already archived artifact.

Metadata logic in this repository

  • CITATION.cff is intended for GitHub citation rendering.
  • .zenodo.json is intended for Zenodo-specific metadata and contributor-role control.
  • The citation-edition version identifies the archived repository release; internal package manifests preserve upstream software package versions where unchanged.
  • Human-readable citation guidance lives in this document and in the README files.

APA-style example

BaiFu. (2026). MiroFish Citation Edition (Version 0.1.2-citation.1) [Computer software]. Zenodo. https://doi.org/10.5281/zenodo.19189253

BibTeX example

@software{Baifu_MiroFish_Citation_Edition_2026,
  author  = {{BaiFu}},
  title   = {{MiroFish Citation Edition}},
  version = {0.1.2-citation.1},
  year    = {2026},
  url     = {https://github.com/ulissesflores/mirofish-citation-edition},
  doi     = {10.5281/zenodo.19189253},
  note    = {Unofficial multilingual citation-ready fork curated by Ulisses Flores}
}

Rule of thumb

Cite the fork DOI for the exact archived edition you used. Also acknowledge the upstream MiroFish repository whenever original authorship or original implementation matters.