Acerca de los archivos de CITATION

Puedes agregar un archivo de CITATION a tu repositorio para ayudar a que los usuarios citen tu software correctamente.

Acerca de los archivos de CITATION

Puedes agregar un archivo de CITATION.cff a la raíz de un repositorio para que otros sepan cómo te gustaría que citaran tu trabajo. El formato de archivo de cita es texto simple con información de cita legible para humanos y máquinas.

Ejemplo de archivo de CITATION.cff:

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Lisa"
  given-names: "Mona"
  orcid: "https://orcid.org/0000-0000-0000-0000"
- family-names: "Bot"
  given-names: "Hew"
  orcid: "https://orcid.org/0000-0000-0000-0000"
title: "My Research Software"
version: 2.0.4
doi: 10.5281/zenodo.1234
date-released: 2017-12-18
url: "https://github.com/github/linguist"

El mensaje de cita de GitHub en tu repositorio te mostrará el contenido de ejemplo de un CITATION.cff en estos formatos:

APA

Lisa, M., & Bot, H. (2017). My Research Software (Version 2.0.4) [Computer software]. https://doi.org/10.5281/zenodo.1234

BibTeX

@software{Lisa_My_Research_Software_2017,
  author = {Lisa, Mona and Bot, Hew},
  doi = {10.5281/zenodo.1234},
  month = {12},
  title = {{My Research Software}},
  url = {https://github.com/github/linguist},
  version = {2.0.4},
  year = {2017}
}

Note the example above produces a software citation (i.e., @software type in BibTeX rather than @article).

Para obtener más información, consulta el sitio web de Formatos de Archivos de Citas.

Cuando agregas un archivo de CITATION.cff a la rama predeterminada de tu repositorio, este se enlaza automáticamente desde la página de llegada del repositorio. Esto hace fácil que otros usuarios citen tu proyecto de software, utilizando la información que proporcionaste.

Enlaze de cita en la página de inicio de un repositorio

Citar algo que no sea software

If you would prefer the GitHub citation information to link to another resource such as a research article, then you can use the preferred-citation override in CFF with the following types.

ResourceType
Research articlearticle
Conference paperconference-paper
Bookbook

Extended CITATION.cff file describing the software, but linking to a research article as the preferred citation:

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Lisa"
  given-names: "Mona"
  orcid: "https://orcid.org/0000-0000-0000-0000"
- family-names: "Bot"
  given-names: "Hew"
  orcid: "https://orcid.org/0000-0000-0000-0000"
title: "My Research Software"
version: 2.0.4
doi: 10.5281/zenodo.1234
date-released: 2017-12-18
url: "https://github.com/github/linguist"
preferred-citation:
  type: article
  authors:
  - family-names: "Lisa"
    given-names: "Mona"
    orcid: "https://orcid.org/0000-0000-0000-0000"
  - family-names: "Bot"
    given-names: "Hew"
    orcid: "https://orcid.org/0000-0000-0000-0000"
  doi: "10.0000/00000"
  journal: "Journal Title"
  month: 9
  start: 1 # First page number
  end: 10 # Last page number
  title: "My awesome research software"
  issue: 1
  volume: 1
  year: 2021

El archivo CITATION.cff anterior producirá los siguientes resultados en el mensaje de cita de GitHub:

APA

Lisa, M., & Bot, H. (2021). My awesome research software. Journal Title, 1(1), 1. https://doi.org/10.0000/00000

BibTeX

@article{Lisa_My_awesome_research_2021,
  author = {Lisa, Mona and Bot, Hew},
  doi = {10.0000/00000},
  journal = {Journal Title},
  month = {9},
  number = {1},
  pages = {1--10},
  title = {{My awesome research software}},
  volume = {1},
  year = {2021}
}

Citing a dataset

If your repository contains a dataset, you can set type: dataset in your CITATION.cff file to produce a data citation string output in the GitHub citation prompt.

Otros archivos de cita

La característica de cita de GitHub también detectará una cantidad pequeña de archivos adicionales que a menudo se utilizan en las comunidades y proyectos para describir cómo quieren que se cite su trabajo.

GitHub enlazará estos archivos en el mensaje de Citar este repositorio, pero no intentará analizarlos en otros formatos de cita.

# Note these are case-insensitive and must be in the root of the repository
CITATION
CITATIONS
CITATION.bib
CITATIONS.bib
CITATION.md
CITATIONS.md

# CITATION files for R packages are typically found at inst/CITATION 
inst/CITATION

Formatos de cita

Actualmente tenemos compatibilidad con formatos de archivo en APA y BibTex.

¡Estás buscando formatos de cita adicionales? GitHub utiliza una librería de Ruby para analizar los archivos de CITATION.cff. Puedes solicitar formatos adicionales en el repositorio ruby-cff o proporcionarlos tú mismo como contribución.

¿Te ayudó este documento?

Política de privacidad

¡Ayúdanos a hacer geniales estos documentos!

Todos los documentos de GitHub son de código abierto. ¿Notas algo que esté mal o que no sea claro? Emite una solicitud de cambios.

Haz una contribución

O, aprende cómo contribuir.