Add a CITATION.cff
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 20.6k
- Fork
- 3.3k
- Metriche di merge delle PR
- Metriche PR in attesa
Descrizione
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.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Crea CITATION.cff nella radice del repository. Inizia esaminando le indicazioni CITATION.cFF di GitHub, la documentazione di Citation File Format e gli esempi collegati di pandas e TensorFlow per identificare i metadati richiesti per mypy. Il lavoro è completo quando il file contiene metadati di citazione completi e validi e GitHub può generare citazioni APA e BibTeX a partire da esso.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Funzionalità
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Specificata chiaramente
- Idoneità per principianti
- 48/100