Consider adding more context for citation formatting

Ouverte
#71 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
55/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
Calme
Domaine
documentation

Piste de recherche

Commencez par localiser dans le guide les consignes de citation et leur modèle, puis lisez le texte environnant ainsi que les conventions existantes pour les admonitions ou les boîtes dépliables. Le travail sera considéré comme terminé lorsqu’un contexte permettant de choisir entre les citations de code et d’article aura été ajouté, tout en conservant la préférence indiquée pour une citation de code et en demandant la citation de l’article dans le README.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
Python
Étoiles
1
Forks
1
Merge moyen
6 j 1 h
PR mergées (30 j)
1

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de Imageomics/Collaborative-distributed-science-guide

Toutes les issues de Imageomics/Collaborative-distributed-science-guide

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.