Uploaded avatar of iHiD

新しいコントリビューションガイドライン

@iHiD
3年弱前

自動でクローズされたイシューやPRからここに案内された場合でも、慌てたり、拒否されたと感じたりしないでください。多くの場合、書いたコードはいずれExercismにマージされますし、問題も解決されます。コントリビュートは歓迎していますし、応援もしています。ただ、GitHubでコードを書き始める前に、まずフォーラムで話し合うことを大切にしています。フォーラムにスレッドを立てれば、物事は前に進みます。


この1年、コアコントリビューターの時間を確保し、トラックをより大きく改善できるようにするため、メンテナー以外からのコントリビュートを制限するという試みを続けてきました。 これはかなりうまくいっています。 2022年と比べて、2023年には新しく追加された演習の数が2倍、作られたシラバスの数が3倍になりました。 この方法の変更によって、コアコントリビューターはより規模の大きいコントリビュートができるようになり、いらだちや気の散りも減りました。

ただ一方で、協力したいと意欲的な新しいコントリビューターが、コントリビュートのプロセスに阻まれて、もどかしさを感じていることも分かっています。 そこで今日は、これから数か月、コントリビュートをどう進めていくかについて、新しい(あるいは明確にした)ガイドラインをいくつか提示したいと思います。

まず理解しておいてほしい基本ルールは、アイデアやバグ、イシューはフォーラムで話し合い、その結果として生まれるコードの変更はGitHub(PRレビュー)で話し合うということです。 二つ目のルールは、(自律的に動けるメンテナーを除いて)何かをする前に必ず話し合うということです。 フォーラムでは、GitHub上で300ものリポジトリを購読して通知があふれてしまうようなことなく、幅広い言語やアイデアについて、さまざまなトラックのコントリビューターやメンテナーが知識と知恵を共有できます。

更新されたガイドライン

サポートを受ける

  • 演習を解く前に困っていること(例:CLIのインストール、テストの実行、演習のロジックや要件が分からないなど)がある場合、サポートの窓口は、フォーラムの「Exercism Support」カテゴリーと、Discordサーバーの#get-helpチャンネルです。
  • サポートの依頼にGitHubやメールは使いません。
  • 演習を解いたあとに疑問がある場合は、Exercism上でメンタリングを依頼してください。

バグやイシューを報告する

  • バグやイシューはすべて、フォーラムで報告してください。そこでは多くの人が問題の理解と解決を手伝ってくれます。
    • 言語に関する内容であれば、該当するProgramming/xxxカテゴリーを使ってください。
    • ウェブサイトのバグであれば、「Bugs & Feature Requests」カテゴリーを使ってください。
  • GitHubのイシューは、たいてい自動でクローズされ、投稿者はフォーラムへ誘導されます(現在と同じく、イシューをコピー&ペーストできるワンクリックのリンク付きです)。
  • トラックのメンテナーは、イシューの自動クローズをオフにすることもできますが、公式な窓口はあくまでフォーラムです。

プルリクエストを送る

  • プルリクエストは、作業を始める前にフォーラムで話し合ってください。
  • 組織のメンバー以外からのプルリクエストは、引き続き自動でクローズされますが、フォーラムで話し合いが済んだあとに、あらためて開かれることがよくあります。 PRのアイデアがすでに承認されている場合は、該当するフォーラムのスレッドにPRのリンクを貼るだけでかまいません。こちらで開き直します。
  • トラックのメンテナーは、PRの自動クローズをオフにすることもできますが、すべてのPRはまずフォーラムで話し合うことをおすすめします。

まとめ

最優先なのは、これまでどおり、コアコントリビューターの時間と心の余裕を守ることです。彼らがいなければExercismは成り立ちません。 同時に、Exercismが、新しく参加する人が厳しすぎる壁に阻まれることなく関われる場所であり続け、そうした人たちが自らコアコントリビューターになれるよう、励まし支えていける場所であり続けたいとも思っています。

この変更が、これから数か月のコントリビュートにどんな影響を与えるのか、楽しみにしています。 2024年の半ばに、あらためて見直す予定です。

Translation missing: ja.number.nth.ordinalized Nov 2023 · 役に立ちましたか?