Consider adding more context for citation formatting

Aperta
#71 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
55/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Ambito
documentation

Direzione di ricerca

Inizia individuando nella guida le indicazioni sulle citazioni e il relativo modello, quindi leggi il testo circostante e le eventuali convenzioni esistenti per admonition o riquadri espandibili. Il lavoro è completato quando viene aggiunto il contesto per scegliere tra citazioni del codice e del paper, mantenendo la preferenza indicata per una citazione del codice e richiedendo la citazione del paper nel README.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
Python
Stelle
1
Fork
1
Merge medio
6g 1h
PR unite (30g)
1

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di Imageomics/Collaborative-distributed-science-guide

Tutte le issue di Imageomics/Collaborative-distributed-science-guide

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.