Consider adding more context for citation formatting

オープン
#71 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
55/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
静か
領域
documentation

調査の方向性

まず、ガイド内で引用に関する指針とそのテンプレートを見つけ、続いて周辺の文言と、既存の admonition または折りたたみボックスの規約を確認します。コードの引用と論文の引用のどちらを選ぶかについての文脈を追加し、コードの引用を優先するという記載された方針を維持したうえで、README で論文の引用を求めれば完了です。

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
Python
スター
1
フォーク
1
平均マージ
6日 1時間
マージ済み PR(30日)
1

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

Imageomics/Collaborative-distributed-science-guide のほかの issue

Imageomics/Collaborative-distributed-science-guide の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。