Lorawan-stack: 質問用のテンプレートを発行します

作成日 2019年07月01日  ·  9コメント  ·  ソース: TheThingsNetwork/lorawan-stack

概要

質問用の問題テンプレートを追加することを提案します。

なぜ私たちはこれが必要なのですか?

#871と#873では、現在の問題のテンプレートが質問に適用できないことがわかります。

すでに何がありますか? あなたは今何を見ていますか?

バグと機能の問題テンプレートがあります。 質問用の問題テンプレートはありませんが、問題テンプレートに従わない問題も受け付けていません。

何が欠けている? あなたは何が見たいですか?

質問用の課題テンプレートを作成するとよいと思います。 このテンプレートには、最初に確認する他の場所のチェックリストを含めることができます

これをどのように実装することを提案しますか?

  • 概要
  • なぜあなたはこの質問をしているのですか?
  • 再現する手順/実行した手順

    • []ドキュメントを検索しましたか?

    • []フォーラムを検索しましたか?

    • []既存の問題を検索しましたか?

  • すでに何がありますか? ドキュメント/フォーラム/問題は何と言っていましたか?
  • あなたの質問に答えるために欠けているものは何ですか?
  • ..。

これを自分で行い、プルリクエストを送信できますか?

最初に話し合いましょう

documentation in progress

最も参考になるコメント

その通り。 「質問」の問題の結果は、通常、ドキュメントの変更、またはFAQへの追加になります。

「質問」の問題を「bug_report」の問題にコピーして貼り付けることが理にかなっているかどうかはわかりません。 質問をバグレポートまたは機能に変えることにした場合は、コメントに関連するセクションを追加する(または問題を編集する)必要があるかもしれません。

全てのコメント9件

したがって、「アクション」は、この問題を参照するドキュメントを直接更新し(それが唯一の変更である場合)、バグ修正/機能要求が発生した場合は別のドキュメントを開くことです。

その通り。 「質問」の問題の結果は、通常、ドキュメントの変更、またはFAQへの追加になります。

「質問」の問題を「bug_report」の問題にコピーして貼り付けることが理にかなっているかどうかはわかりません。 質問をバグレポートまたは機能に変えることにした場合は、コメントに関連するセクションを追加する(または問題を編集する)必要があるかもしれません。

同意しますが、それはフォーラムとスラックにも当てはまるはずです。

本質的に、すべての情報はリポジトリのドキュメントに含まれている必要があります。一部の情報がフォーラム、問題、またはスラックで参照されている場合、ドキュメントを作成できませんでした。
Slackで提起された質問や問題については、情報を探すための努力が払われていない限り、フォーラムはドキュメントの変更を補う必要があります。

「そこを見ましたか」のリストを用意する代わりに、github / docのクエリへのリンクを追加します(検索が実装されたら)。 githubの問題で情報を探すのは面倒な場合があり、フォーラムにはドキュメントにない情報や説明を含めるべきではありません。 すでに確立されているクエリ(バグの検索など)へのリンクが役立ちます。 既知のバグのセクションをドキュメントに追加することも考えられます。

質問がバグに光を当てた場合、それをバグとして認定する(そして問題をバグレポートとして編集する)か、質問の一部だけがバグに関係している場合は別の問題を開くのは開発者の責任です。

私は、フォーラムとSlackをより適切に監視し、(良い)質問をドキュメントの改善に変える必要があることに完全に同意します(少なくともv3カテゴリlorawan-stackチャネルの場合)。 @Sypheosそれが

「ここを見ましたか」の目標は、検索を行う前に問題を送信する人々のためのフィルターでした。 次のセクションはもっと便利です。そこでは、問題の送信者に、関連するフォーラムの投稿、スラックメッセージなどにリンク(または引用)するように依頼できます。

これはいい考えだと思います。 この問題の範囲を維持し、テンプレートを発行して、本当に新しい質問にしましょう。

ドキュメントの改善、つまり、ドキュメントの一部が必要なフォーラムやSlackでの非公式な回答については、最小限の追加の「ドキュメントリクエスト」発行テンプレートを検討する場合があります。 基本的に、ドキュメントのギャップと、情報がある場合はその場所へのリンク(つまり、フォーラム/ Slackメッセージへのリンク)について説明します。 しかし、繰り返しになりますが、私にとっては、この問題の範囲外です。

質問テンプレートimoの場合:
何を探している/する?
どこを見ましたか?
_ウェブページの追加、問題、githubに対するクエリ、ドキュメント、フォーラムは大歓迎です_
なぜ満足できなかったのですか?
_404が見つかりませんは正当な回答です_

ラベル:質問

質問に答えるリソースがない場合は、「ドキュメントリクエスト」の問題を開きます。

回答がドキュメントに含まれるようにする必要があります。そうしないと、ここで閉じられた問題がV3ナレッジベースになり、それを回避する必要があります。したがって、「質問」テンプレートをスキップして、「ドキュメント要求」に直接進む必要があるかもしれません。

また、このリポジトリの使用が増え、質問をするための頼りになる場所になり、それをモデレートするのに苦労する(つまり、ドキュメントを指摘して問題を閉じる)と、将来的に後悔する可能性があります。 VS Codeのような大きなリポジトリは、あまり積極的に質問するべきではないことを伝えていることに注意してください。

Screenshot 2019-07-01 at 17 50 45

Screenshot 2019-07-01 at 17 50 54

要するに、考えてみましょう。

  • 質問は一切許可せず、「文書化要求」の問題のみを許可します。質問は引き続き有効ですが、実際に文書化されていない場合に限り、それ以外の場合は有効な文書化リクエストではないため、終了します
  • ドキュメント(ある場合)とフォーラムに直接質問する

ドキュメントのリクエストは、何かを探していたのに見つからなかったため、実際には「質問」です。 最初に、彼らは答えを必要とする質問をします。
その方向に進むには、githubの問題を介してドキュメントのリクエストや質問を単に拒否する方が理にかなっています。

誰かが質問をしたい場合は、Slackまたはフォーラムにアクセスして、コアチームまたはモデレーションの誰かがドキュメントのPR /バグの問題/機能のリクエストの問題で質問を投げかけることができます。

決定: https: //github.com/TheThingsNetwork/lorawan-stack/issues/890#issuecomment-507324845を使用します。 フォーラムに誘導する質問テンプレート、およびドキュメントリクエストテンプレート

このページは役に立ちましたか?
0 / 5 - 0 評価