Skip to content

CITATION.cff file for citing repository #399

Closed

Description

@a-darcher

Use Case

I use PySceneDetect as part of an on-going research project and want to cite it in a paper. I haven't found a preferred citation anywhere (hopefully have not missed something obvious). It might be useful to add a CITATION.cff file to the root directory to take advantage of the "Cite this repository" feature of GitHub repos (see here).

Proposed Implementation:

GitHub has a fill-in form/tool available here.

Examples:

A possible example CITATION.cff file might be something like:

cff-version: 1.2.0
authors:
  - family-names: Castellano
    given-names: Brandon
title: "PySceneDetect"
version: 0.6.3
type: software
repository-code: 'https://github.com/Breakthrough/PySceneDetect/'
date-released: 2024-03-98

Activity

  1. added this to the v0.6.4 milestone on Jun 8, 2024
  2. added a commit that references this issue on Jun 9, 2024
  3. Breakthrough commented on Jun 9, 2024

    @Breakthrough
    Owner

    Thanks for the suggestion, done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions