Inclusion of a CITATION.cff file

[joaoccruz]

CITATION.cff files are plain text files with human- and machine-readable citation information for software (and datasets). Code developers can include them in their repositories to let others know how to correctly cite their software. cff documentation.

The inclusion of this file would be greatly appreciated

[jsvine]

Hi @joaoccruz, and thanks for the suggestion. Although I'm generally wary of bloating the root-level directory with a ton of niche files, CITATION.cff seems like a reasonable one. A couple of questions that will help with implementation:

• Is there another repository that you think publishes a particularly useful CITATION.cff file?

• Do you have an opinion on providing a CITATION.cff file without assigning the repository/release a DOI?

[joaoccruz]

Hi @jsvine thanks for the follow up!

Regarding your first question: I'd recommend checking out NLTK, they have a very good CITATION.cff

As for the second question, I do not find a DOI required. To my knowledge, it is most often (if not exclusively) used in scientific publications such as journals or conference papers. NLTK, for instance, did not include one, despite requesting citations on their book.

Thanks for your time,
João Cruz

[jsvine]

Thanks, that's very helpful. How does this look to you?: https://github.com/jsvine/pdfplumber/blob/develop/CITATION.cff

[jsvine]

Closing this belatedly, as the CITATION.cff file has been added in 6af87ab and merged. Thanks again @joaoccruz.