モジュールメンテナーのガイドライン

Ansible のコードベースのメンテナーになっていただきありがとうございます。本ガイドでは、モジュールメンテナーの責任の概要、追加情報のリソース、役立つツールへのリンクを紹介します。

以下の情報に加えて、モジュールメンテナーは以下について理解しておく必要があります。

メンテナーの役割

新しいモジュールを ansible/ansible リポジトリーに提供し、それがマージされると、モジュールのメンテナーになります。メンテナンスは、モジュールに対してプル要求を行うための改訂を許可、拒否、または要求する権限を持ちますが、「権限が大きくなると責任も大きくなる」とも言えます。

Ansible モジュールのメンテナーは、保守を行っているモジュールへのプル要求や問題に対するフィードバック、応答、アクションを合理的なタイミングで提供することが期待されます。

また、「貢献のガイドライン」は常に改善されているため、時々見直すことが推奨されます。場合によっては、モジュールが一般的に受け入れられている標準的な要件に近づけるために、モジュールを更新するように要求されることがあります。このようなことは頻繁には怒らず、(たとえば「明日までに」ではなく) 常にかなりのリードタイムをかけた要求となることが期待されます。

最後に、ansible-devel メーリングリストをフォローすることは、より広範な Ansible コミュニティーに参加するための素晴らしい方法であり、Ansible とそのモジュールの全体的な方向性、品質、目標に影響を及ぼすことができる場所でもあります。比較的ボリュームの少ないこのメーリングリストに参加していない場合は、https://groups.google.com/forum/#!forum/ansible-devel からご参加ください。

Ansible コミュニティーは、モジュールを保守することが、より大きなコミュニティーでモジュールを保守することと同じくらいやりがいを感じることを願っています。

プル要求、問題、およびワークフロー

プル要求

モジュールのプル要求は、メインの Ansible リポジトリー にあります。

プル要求の量が多いため、特定のモジュールへの PR の通知は自動ボットによって適切なメンテナーに送られて処理されます。自身の GitHub ID に関する通知を受け取るために、適切な通知プロセスを設定することが推奨されます。

問題

バグレポート、ドキュメントのバグレポート、機能要求などのモジュールの問題は、Ansible リポジトリー で追跡されます。

モジュールの問題は、自動化プロセスによりメンテナーに送られます。このプロセスは現在も改良中であり、現時点では、問題が正しく送信されるようにするには、問題の作成者が適切な詳細を提供すること (具体的には適切なモジュール名を指定すること) に依存しています。特定のモジュールのメンテナーになっている場合は、定期的にモジュールの問題を検索して、メンテナーとなっているモジュールの名前 (または類似する名前) が記載されている問題を見つけ、自身の GitHub ID が記載されている場合に通知を受け取るための適切な通知プロセスを設定することが推奨されます。

PR ワークフロー

プル要求の自動ルーティングは、Ansibot と呼ばれるツールによって処理されます。

ボットの背後にあるワークフローがどのように起動するかをある程度理解しておくと、問題が発生した場合に、提供されるフィードバックが、Ansibullbot の進化を継続的に支援しているユーザーに役に立つ可能性があります。

PR ワークフローの詳細な説明は、「Ansible 開発ライフサイクル」を参照してください。

メンテナー (BOTMETA.yml)

メンテナーの一覧は、BOTMETA.yml にあります。

メンテナーの追加と削除

コミュニティーは時間とともに変化し、誰かがモジュールを永久に維持するというわけではありません。自身のモジュールにメンテナーの追加を提案したい場合は、新しいメンテナーの GitHub ユーザー名を指定して、BOTMETA.yml に PR を提出してください。

メンテナーを辞めたい場合は、該当するモジュールから GitHub ID を削除する PR を BOTMETA.yml に送信してください。これによりモジュールからメンテナーがいなくなる場合は、「ansible」をメンテナーにします。これは、モジュールにメンテナーが一時的にいないことを示し、Ansible コミュニティーチームが新しいメンテナーを探していることを示します。