python / python/mypy

Add a CITATION.cff

Abierto
#15,415 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

feature
Lenguaje dominante
Python
Estrellas
20.6k
Forks
3.3k
Métricas de merge de PR
Métricas de PR pendientes

Descripción

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.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Crea CITATION.cff en la raíz del repositorio. Empieza revisando las directrices de CITATION.cFF de GitHub, la documentación de Citation File Format y los ejemplos enlazados de pandas y TensorFlow para identificar los metadatos necesarios para mypy. La tarea estará terminada cuando el archivo contenga metadatos de citación completos y válidos, y GitHub pueda generar citas en formato APA y BibTeX a partir de él.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
documentation
Tipo de issue
Nueva funcionalidad
Dificultad
2/5
Tiempo estimado
1-3 horas
Estado de actividad
Estancado
Claridad
Bien especificado
Aptitud para principiantes
48/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.