イシューのトリアージ
このガイドはメンテナー向けです。 これらの特別な人々は、Jekyllのリポジトリの1つ以上に書き込みアクセス権を持ち、他の人々の貢献をマージするのを手伝います。ここに書かれていることは興味深いかもしれませんが、すべての人向けではありません。
イシューを評価する前に、それが機能リクエストなのかバグなのかを特定することが重要です。Jekyllプロジェクトでは、機能とバグを特定するために次の定義が使用されます。
機能 - 機能は、現在のJekyllの機能範囲外の機能をJekyllに追加するリクエストとして定義されます。バグ - バグは、ユーザーが現在のJekyllの機能を使用する際に遭遇するエラーを特定するイシューとして定義されます。
機能?
イシューが機能リクエストを記述している場合は、次のように質問します。
- これは設定ですか? 設定は「正しいことを行う」ための松葉杖です。設定は通常、悪いデフォルトまたはプラグインで簡単に解決できるエッジケースを示しています。製品の使いやすさを損なわないように、設定の
を可能な限り小さくしてください。私たちは「オプションではなく決定」という哲学が好きです。
- 少なくとも80%のユーザーが便利だと感じるでしょうか?ユーザーの4分の1さえも使用しない場合、そのリクエストは製品のコア目標に適合しない可能性が非常に高いです。
- リクエストの最終目標を達成する別の方法はありますか?ほとんどの機能リクエストは、既存の機能に関するドキュメントの不備または理解不足が原因です。リクエストの最終目標を明確にできるかどうかを確認してください。ユーザーは何をしようとしていますか?すでにサポートしている別の機能を通じてその目標を達成できますか?
- ユーザーの80%が使用するとしても、プロジェクトのコア目標に適合しますか?私たちは静的Webサイトを作成するためのツールを開発しているのであり、より一般的に公開するための万能ナイフではありません。
他の人の意見を聞いたり、イシューの作成者に質問したりしても構いませんが、上記の質問に対する回答によっては、プロジェクトの範囲外になる可能性があります。
リクエストが範囲内である場合は、他のメンテナーと共に製品ロードマップで優先順位を付けます。適切なタグを適用し、機能の範囲と実装を定義するために適切な人々が意見を述べたことを確認します。これまでで最高になりたい場合は、その機能を追加するPRを自分で提出してください。
バグ?
再現性
バグに明確な再現手順がある場合は、少し時間を取って試してください。可能であれば、問題を再現するシナリオのテストをテストスイートに記述してください。問題を確実に再現できますか?
問題を再現できない場合は、うまくいかなかった再現手順を投稿し、イシューの作成者に説明を求めてください。
サポートされているプラットフォーム
作成者はサポートされているプラットフォームを使用していますか?macOS、Ubuntu、Debian、CentOS、Fedora、Arch Linuxの最新バージョンをサポートしています。
作成者がサポートされているプラットフォームで問題を再現できない場合は、すぐにイシューをクローズできます。Windows関連の問題については、Windowsは正式にはサポートされていないことをユーザーに知らせるコメントを残してください。ただし、@jekyll/windows
のメンバーと引き続きコミュニケーションを取り、さらに調査するためにイシューを使用することはできます。さらに、コミュニティからサポートを得る手段として、Jekyll Talk(https://talk.jekyllrb.com)を紹介することもできます。
GitHub Pagesまたは再現できない他のホストプラットフォームで問題が発生している場合は、プラットフォームのサポートチャネルに誘導し、イシューをクローズしてください。
彼らが望んでいたもの vs. 彼らが手に入れたもの
ユーザーが手に入れたものと、手に入れることを期待していたものについての明確な説明がないイシューは、正確に対応できないイシューです。ユーザーがこの情報を提供しない場合は、説明を求め、pending-feedback
ラベルを適用してください。この情報は、将来的に動作が壊れないようにテストケースを作成するのに役立ちます。pending-feedback
ラベルは、イシュー作成者が返信を投稿すると自動的に削除されます。
彼らが手に入れたかったものは、私たちが起こってほしいものですか?バグレポートが実際には機能リクエストを装っている場合があります。機能リクエストの処理については、上記のガイダンスを参照してください。
停滞と自動クローズ
@jekyllbotは、少なくとも1か月間アクティビティがない場合、イシューを自動的にstale
としてマークします。@jekyllbotは、現在のバージョンでの再現性に関する情報を求めるコメントを残します。さらに1か月後に誰も応答しない場合、イシューは自動的にクローズされます。この動作は、pinned
ラベルを設定することで抑制できます。