improve "third party code" section

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

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

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
20/100
issue の種類
ドキュメント
明瞭さ
説明が足りない
活発さ
停滞
領域
documentation

調査の方向性

ファイル、テスト、エントリーポイントのいずれも指定されていません。既存の “third party code” セクションとリンク先の MAGMA_Celltyping submission を確認し、そのうえでバイナリの再配布またはプラットフォーム固有のインストールを対象に含めるべきかを判断してください。合意されたポリシーと、ライセンス、サイズ、プラットフォームの要件を明記した更新済みのセクションがあれば完了です。

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

説明

The term "third party code" is somewhat vague. We are seeing submissions that attempt to redistribute
standalone binaries in the package, and I don't know that we have a specific policy on this. I don't like
it, but it seems it will be effective in certain circumstances. I think we should state that the redistribution of
binaries can be allowed with explicit licensing for redistribution included with the package; package must
meet all size requirements with the included binaries, and should be checkable on all three platforms.

Another way to handle a binary is to include code for platform-specific installation of the binary in BiocFileCache?

This is coming up in connection with a prospective submission https://github.com/neurogenomics/MAGMA_Celltyping/blob/bschilder_dev/DESCRIPTION ... which would like to redistribute https://ctg.cncr.nl/software/magma.

主要言語
HTML
スター
16
フォーク
27
平均マージ
3時間 51分
マージ済み PR(30日)
4

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

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

Bioconductor/pkgrevdocs のほかの issue

Bioconductor/pkgrevdocs の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

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

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