Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CITATION.cff #1639

Closed
schackartk opened this issue Jun 11, 2023 · 2 comments · Fixed by #1641
Closed

Add CITATION.cff #1639

schackartk opened this issue Jun 11, 2023 · 2 comments · Fixed by #1641
Labels
docs enhancement New feature or request fixed

Comments

@schackartk
Copy link
Contributor

Is your feature request related to a problem? Please describe.
I am unsure of how to properly cite coveragepy in a research article.

Describe the solution you'd like
I would like to see a CITATION.cff file in the root of the repository.

GitHub recommends, and integrates support for, CITATION.cff files. Inclusion of this file would immediately have these benefits:

  • Users will have the necessary metadata to properly cite mypy.
  • GitHub can automatically generate both APA and BibTeX formatted citations. A "Cite this repository" option will automatically appear on the repo's sidebar when viewed on a desktop browser.
  • Reference managers like Zotero will automatically detect the metadata so the user can save the citation to their library.

Describe alternatives you've considered
The other main options are to supply a suggested citation in the README or other documentation, or to have a BibTeX formatted citation file. However, GitHub has better support for CFF formatted citations.

Additional context
Examples of popular packages using this are pandas and tensorflow.

I would be happy to create an initial version of this and open a PR if there is interest in possibly merging it after refinement.

@schackartk schackartk added enhancement New feature or request needs triage labels Jun 11, 2023
@nedbat
Copy link
Owner

nedbat commented Jun 11, 2023

I'm fine with adding this file. It would be nice if it didn't need to be a separate file, but I understand.

@nedbat nedbat added docs and removed needs triage labels Jun 11, 2023
@schackartk
Copy link
Contributor Author

Yeah, it can always be a pain adding yet another file to the root of the repo.

I will draft one up and submit a pull request though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs enhancement New feature or request fixed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants