Consider adding more context for citation formatting

Abierto
#71 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
55/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Tranquilo

Línea de trabajo

Comienza localizando en la guía las indicaciones sobre citas y su plantilla; después, lee el texto circundante y cualquier convención existente para admoniciones o cuadros desplegables. Se considerará terminado cuando se añada contexto para elegir entre citas de código y de artículos, manteniendo la preferencia indicada por una cita de código y solicitando la cita del artículo en el README.

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

Descripción

One comment re: wording [for citation guidance] to perhaps consider: That we generally want to ask people to cite both software and paper (if there is a paper) is an institutional practice we chose. But prioritizing the paper citation can also be a choice, which can result in actually wanting the paper citation to show up on the sidebar on GitHub (and perhaps including the code citation BibTeX in the README instead).

I don't have a good suggestion for how to convey this being a choice when instantiating the template, and of course there are a variety of reasons why code as a first-class citizen in citation networks should be promoted. So maybe this is best deferred to considering at a later time.

Originally posted by @hlapp in https://github.com/Imageomics/Collaborative-distributed-science-guide/pull/69#pullrequestreview-4189999222

We may consider including more context in a collapsible box/admonition for those interested in deciding between the two options. The preferred option is still to have a code citation and ask for paper citation in the README.

Lenguaje dominante
Python
Estrellas
1
Forks
1
Merge medio
6 d 1 h
PR fusionados (30 d)
1

Preparar el entorno

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.

Más de Imageomics/Collaborative-distributed-science-guide

Todos los issues de Imageomics/Collaborative-distributed-science-guide

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.