python / python/mypy

Add a CITATION.cff

Offen
#15,415 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

feature
Vorherrschende Sprache
Python
Sterne
20.6k
Forks
3.3k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Erstelle CITATION.cff im Stammverzeichnis des Repositorys. Beginne damit, die CITATION.cFF-Richtlinien von GitHub, die Dokumentation zum Citation File Format sowie die verlinkten Beispiele von pandas und TensorFlow zu prüfen, um die erforderlichen Metadaten für mypy zu identifizieren. Die Aufgabe ist erledigt, wenn die Datei vollständige, gültige Zitationsmetadaten enthält und GitHub daraus APA- und BibTeX-Zitate generieren kann.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Feature
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
48/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.