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 file #3722

Closed
schackartk opened this issue Jun 7, 2023 · 0 comments · Fixed by #3723
Closed

Add CITATION.cff file #3722

schackartk opened this issue Jun 7, 2023 · 0 comments · Fixed by #3723
Labels
T: enhancement New feature or request

Comments

@schackartk
Copy link
Contributor

Is your feature request related to a problem? Please describe.

I am unsure how to cite Black in my research articles.

It would be useful to have an explicit metadata component describing how to cite Black.

Describe the solution you'd like

A CITATION.cff file could be added to the root of the repository. This would allow GitHub to automatically generate a citation in both APA and BibTeX format. Additionally, reference manager plugins such as Zotero will be able to automatically capture the citation information.

Describe alternatives you've considered

The citation information could be added directly to the documentation, or an alternative citation format could be used such as BibTeX. But .cff seems to be the method recommended by GitHub.

Additional context

Similar citation files are used by popular libraries such as pandas and tensorflow, although some use BibTeX format instead such as NumPy. However, using BibTeX means that GitHub cannot automatically generate the citations (in APA) but instead just point to the citation file.

@schackartk schackartk added the T: enhancement New feature or request label Jun 7, 2023
@schackartk schackartk mentioned this issue Jun 7, 2023
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T: enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant