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.

Sign up for GitHub

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

Jump to bottom

Add CITATION.cff #8760

Closed
schackartk opened this issue Jun 11, 2023 · 1 comment · Fixed by #8777 or #9093
Closed

Add CITATION.cff #8760

schackartk opened this issue Jun 11, 2023 · 1 comment · Fixed by #8777 or #9093
Labels
Documentation 📗 Needs PR This issue is accepted, sufficiently specified and now needs an implementation

Comments

@schackartk
Copy link
Contributor

Current problem

I would like to cite pylint in a research article and it is unclear how pylint should be cited.

Desired solution

I would like pylint to have 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 pylint.
  • 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.

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 the Needs triage 📥 Just created, needs acknowledgment, triage, and proper labelling label Jun 11, 2023
@Pierre-Sassoulas Pierre-Sassoulas added Documentation 📗 Needs PR This issue is accepted, sufficiently specified and now needs an implementation and removed Needs triage 📥 Just created, needs acknowledgment, triage, and proper labelling labels Jun 12, 2023
@Pierre-Sassoulas
Copy link
Member

Thank you for opening the issue and for citing pylint in your research. Definitely interested by merging what you can suggest and I think that would be pretty cool to have.

@schackartk schackartk mentioned this issue Jun 12, 2023
Closed
Pierre-Sassoulas pushed a commit to Pierre-Sassoulas/pylint that referenced this issue Jun 14, 2023
@schackartk @Pierre-Sassoulas
Add a CITATION.cff containing the necessary metadata to cite Pylint
1efe793 
Refs pylint-dev#8765, Closes pylint-dev#8760
@Pierre-Sassoulas Pierre-Sassoulas mentioned this issue Jun 14, 2023
Merged
Pierre-Sassoulas added a commit to Pierre-Sassoulas/pylint that referenced this issue Jun 14, 2023
@schackartk @Pierre-Sassoulas
Add a CITATION.cff containing the necessary metadata to cite Pylint
0671830 
Refs pylint-dev#8765, Closes pylint-dev#8760

Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
Pierre-Sassoulas added a commit that referenced this issue Jun 14, 2023
@schackartk @Pierre-Sassoulas
Add a CITATION.cff containing the necessary metadata to cite Pylint
bafb229 
Refs #8765, Closes #8760

Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
@Pierre-Sassoulas Pierre-Sassoulas mentioned this issue Oct 2, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation 📗 Needs PR This issue is accepted, sufficiently specified and now needs an implementation
Projects
None yet
Milestone
No milestone
2 participants
@Pierre-Sassoulas @schackartk