メンタリング、責任、引き継ぎ
責任は、経験と意思に合わせて。
どの段階でも止まれます。挙動変更・互換性変更・公開リリースにはメンテナレビューが必要です。
詳しい説明・手順を読む
CPAN Rescue は、メンテナンスを永久的な ownership(所有)ではなく、stewardship(預かって守る責任)として捉えます。責任は意識的に段階を踏んで増やし、活動から退くことも、支援を受けながら選べる普通の選択肢にするべきです。
責任の段階
Explorer(探索者)
調査、不具合の再現、リリースやソースの比較、証拠の記録を行えます。この段階に、リリース権限や実際の利用時の挙動を変更する権限は含まれません。
示すべき証拠:再現可能なコマンド、環境の詳細、調査結果、明確な次のアクション。
Contributor(コントリビュータ)
焦点を絞ったテスト、CI、メタデータ、ドキュメント、バグ修正を提案できます。実際の利用時の挙動を変更するには、レビューと、その変更が必要な問題の実証が必要です。
示すべき証拠:レビュー可能な Issue / PR、必要に応じた回帰の証拠、テスト結果。
Release Contributor(リリース・コントリビュータ)
リリース候補、生成されたメタデータ、tarball、下流テスト、リリース後の検証結果を準備・検証できます。この役割に PAUSE へのアップロード権限は含まれません。
示すべき証拠:対象のソースと成果物を正確に特定できる情報、ビルド・テスト環境、実施した確認とその結果。
Co-maintainer(共同メンテナ)
既存のメンテナと、継続的な問題の切り分け・優先順位付けやメンテナンスを分担します。リポジトリや PAUSE の権限は、実際に委ねられる作業に見合うものにするべきです。
示すべき証拠:複数のタスクにわたるレビュー済みのメンテナンス判断、明確なコミュニケーション、実証された保守的な判断力。
Maintainer / Steward(メンテナ / スチュワード)
適切な権限とプロジェクトに関する知識・背景を得たディストリビューションについて、独立してメンテナンスとリリースを判断できます。stewardship には、他の人へ引き継げる状態を整えることも含まれます。
レビューの方針
現状の観察や容易に元に戻せる作業は、独立して進められます。基準状態の調査、不具合の再現、ドキュメント作成、ブランチ上での CI 実験、テストのみの変更などが該当します。
実際の利用時の挙動を変更するコードのマージ、互換性の保証範囲の変更、正式なリポジトリやリリースに関するメタデータの変更、リリースの公開には、事前にメンテナのレビューが必要です。
XS コード、セキュリティ上重要な境界、CPAN River 上で影響が大きい変更、広範囲の API・挙動変更、下流への影響が不確かな変更では、より慎重なレビューを行います。その場合は、焦点を絞った回帰の証拠、代表的な下流ディストリビューションのテスト、必要に応じた developer release(開発版リリース)を優先します。
リリース成果物を検証するだけのために、コントリビュータがリリース用の認証情報を必要とする状態にしてはいけません。
メンタリング
タスクには、期待する成果、前提条件、検証方法、責任の範囲、質問先を明記するべきです。質問やドキュメントの不足は、有用なメンテナンスの証拠であり、コントリビュータの失敗ではありません。
メンターやレビュアーは、リポジトリだけでは分からないプロジェクトの歴史やリリースに関する知識に基づく判断を説明するべきです。レビューでは、書き方の好みで参加のハードルを上げるのではなく、安全性と再現性を重視します。
メンテナンス記録
コントリビュータ向け・育成段階のタスクでは、他の人や環境に引き継げるよう、十分な公開証拠を記録します。
- コントリビュータと対象ディストリビューション
- メンテナへの道筋における段階とタスクの範囲
- Issue / PR / コミットなどの証拠
- 関連する環境とツール
- 実証されたメンテナンスのスキル
- レビュアー・メンター
- 明示された責任の範囲
- 有用な場合は、コントリビュータとレビュアーの作業時間のおおまかな範囲
この記録を、点数、認定、作業速度の比較、ランキングにしてはいけません。
引き継ぎ・活動終了のチェックリスト
活動から退きたいメンテナは、該当する範囲で次のことを行うべきです。
- 現在のリリース、ソースブランチ、既知の回帰、進行中のリリース作業、重要な下流リスクを記録する。
- 正式なリポジトリと Issue トラッカーを明確にする。
- 別のメンテナが再現できる程度に、リリース手順を文書化する。
- 未対応の Issue / PR を洗い出し、緊急の作業と任意の近代化を区別する。
- リポジトリのコラボレータ・所有者の変更を調整する。
- 適切な手続きを通じて、PAUSE の first-come / co-maint 権限の変更を調整する。
- CI・リリースに必要な依存関係や、秘密情報を含まない設定要件を引き継ぐか、文書化する。
- 秘密情報や個人の認証情報を、プロジェクトのドキュメントにコピーしたり、非公式に引き渡したりしないようにする。
- 有用な場合は、後任メンテナを関連する upstream / downstream の連絡先に紹介する。
- 引き継ぎを公開記録に残し、移行後に誰が責任を担うかを明示する。
後任が見つからない場合も、可能な範囲で、黙って活動を止めるのではなく、メンテナンスの状態を文書化し、共同メンテナや adoption(保守の引き受け)を募ります。
原則
どのコントリビュータにも、次の段階へ進む義務はありません。どのメンテナにも、無期限に活動を続ける義務はありません。健全な stewardship の仕組みでは、参加と活動終了の両方が明確で、レビュー可能で、関係者にとって予想外の出来事にならないようにします。