You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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:
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.
The text was updated successfully, but these errors were encountered: