python / python/mypy

Add a CITATION.cff

Open
#15,415 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature
Dominant language
Python
Stars
20.6k
Forks
3.3k
PR merge metrics
PR metrics pending

Description

Feature

Add a CITATION.cff file to the root of the repository that contains all the necessary metadata to properly cite mypy.

Pitch

There has been a trend in some scientific communities encouraging proper citation of all tools used to conduct research. While this generally includes research methods, it may also include software tools such as mypy.

However, it can be difficult to know how to properly cite software if the information is not explicitly provided. It is helpful if the software maintainers/developers provide users with this information.

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.

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Create CITATION.cff at the repository root. Start by reviewing GitHub’s CITATION.cFF guidance, the Citation File Format documentation, and the linked pandas and TensorFlow examples to identify the required metadata for mypy. Done means the file contains complete, valid citation metadata and GitHub can generate APA and BibTeX citations from it.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.