RustSec Advisory Database 日本語訳 誤訳を知らせる
RustSec Advisory Database の文書保守されていない crate の助言
  1. 概要と助言の書式(README)
  2. 助言を作る(CONTRIBUTING)
  3. 助言の例
  4. 保守されていない crate の助言

手引き: 保守されていない crate の助言

この文書は、保守されていない(unmaintained)crate についての助言を RustSec Advisory Database に追加するときの方針を説明します。

これらの助言は、あるプロジェクトの中に保守されていない crate があることを Rust のコミュニティに知らせるとともに、保守されている代替への乗り換えを案内する役目を持ちます。

保守されていないかもしれない crate に向き合うときは、オープンソースのメンテナに対して無礼にふるまわないでください。保守されていない crate について RUSTSEC の助言を出すことを、オープンソースのメンテナに何かを強いるための武器として扱うべきではありません。

「保守されていない」crate の定義

次のどちらかに当てはまる crate を、保守されていないものと見なします。

保守されていない crate の助言を作る

方針

迷ったときは、連絡が取れる限り、保守されていない crate の助言を出してほしいかどうかについて、つねに crate の作者の判断に従います。

何よりもまず、作者に尋ねてください。できれば、プロジェクトのソースコードのリポジトリで、公開の issue として尋ねます。その crate の作者やメンテナが、保守されていない crate の助言を出すのは良い考えだと言うなら、それで結構です。進めてください。

作者から返答があり、プロジェクトは保守されていると宣言した場合、RustSec の組織はそれを保守されているものと見なし、保守状況についての助言は受け付けません。繰り返しますが、迷ったときは作者の判断に従います。作者から返答があり、crate は保守されていると明言している限り、その言葉を信じます。最近のコミット、未解決の issue、最新のリリースなどのリポジトリの指標は、crate の作者の直接の言葉に逆らう理由にはなりません。

一方で、crate の作者への連絡を試みて失敗した場合は、最近のコミット、未解決の issue、最後のリリースからの期間などの指標が、crate が保守されていないことを裏づける重要な証拠になります。crate への作業が続いている証拠があるなら、作者と連絡が取れないことは問題になりません。

crate の作者に連絡が取れない場合の「暗黙的に保守されていない」という状態を裏づけるには、次の基準を満たさなければなりません。

手順

保守されていない crate の助言は、RustSec のセキュリティ助言と同じ構造を使いますが、TOML の助言に informational = "unmaintained" という属性を含めます。

助言を作るときは、助言の url = "..." フィールドに、保守状況が話し合われた上流プロジェクトのリポジトリの issue へのリンクを含めてください。

上流プロジェクトのリポジトリで issue が無効になっている場合や、上流の issue が事情を十分に説明していない場合は、advisory-db プロジェクトの issue にリンクする url = "..." を含めてください。

RustSec のデータベースに助言を追加する方法について、詳しくは助言を作るを見てください。

質問

GitHub の issue を開いてください。

https://github.com/rustsec/advisory-db/issues