Imageomics / Imageomics/Collaborative-distributed-science-guide
Consider adding more context for citation formatting
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 1
- Fork
- 1
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
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.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
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.
Valutazione
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Tranquilla
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 55/100