メインコンテンツまでスキップ

How to cite River Review

Here is how to cite River Review in research or articles. The single source of truth for the citation metadata is CITATION.cff at the repository root.

GitHub "Cite this repository"​

On the repository's GitHub page, the right sidebar's "Cite this repository" button generates an APA / BibTeX citation from CITATION.cff. This is the easiest path — no manual entry required.

BibTeX​

For version and date, use the version in CITATION.cff at citation time and the date of the release you used.

@software{river_review,
  title   = {River Review},
  author  = {{River Review maintainers}},
  url     = {https://github.com/s977043/river-review},
  version = {X.Y.Z},
  date    = {YYYY-MM-DD},
  license = {MIT}
}

Plain text​

River Review maintainers (YYYY). River Review (Version X.Y.Z) [Software]. https://github.com/s977043/river-review

About the DOI​

  • There is no DOI yet.
  • Once the Zenodo–GitHub integration is enabled and a DOI is minted for a release, the doi field in CITATION.cff and this page will be updated.
  • The version and date change with each release, so treat the values in CITATION.cff as authoritative when you cite.