要約
このドキュメントのトピックでは、Discourse で機能リクエストを作成する方法について、ステップバイステップガイドで説明します。
ステップ 1: 開始する前に
Discourse の優れた機能のアイデアをお持ちですか？それは素晴らしいことです！チームやコミュニティに効果的に共有する方法を以下に示します。機能リクエストを送信する前に、アイデアがすでに提案または実装されていないか、既存のディスカッションを検索するためにしばらく時間を取ってください。これにはいくつかの方法があります。
- Feature カテゴリで探す
- ページ右上の
アイコンをクリックして 検索 を表示する。高度なフィルターを使用して、カテゴリとタグで絞り込むことができます。 - pr-welcome タグが付いたトピックを確認する - PR は GitHub のプルリクエストのことであり、開発者がプロジェクトに新しいコードを導入する方法です。
- completed タグが付いたトピックを確認する
- Plugin および Theme component カテゴリで確認する
機能の提案がすでにリストされている場合は、投票してリクエストを目立たせたり、いいねを付けたり、追加のアイデアやユースケースを返信したりして、その機能が追加されるべき理由とその有用性をさらに伝えることで、サポートすることができます。
アイデアに関する言及が見つかりませんか？機能リクエストを作成できます。
ステップ 2: 基本
タイトル
トピックのタイトルは情報量が多く、かつ長すぎないようにすることが重要です。リクエストの範囲が一目で簡単に識別できるようにする必要があります。
カテゴリ
新しいトピックを作成する際は、Feature カテゴリを選択してください。
タグ
タグは機能をグループ化および分類するために使用されるため、リクエストを整理するためにトピックに適切にタグを付けることは、追跡目的で非常に役立ちます。たとえば、chat プラグインに関連するすべてのものは、1つのタグの下にまとめられます。
ステップ 3: リクエストの作成
優れた機能リクエストを作成することは重要です。これにより、Discourse チームは改善が必要な領域を迅速に特定できます。
機能リクエストを作成する際は、自分のアイデアを売り込み、その機能のアイデアが十分な根拠に基づいていることを人々に納得させようとしていることを忘れないでください。コミュニティ、自分自身、およびチームのために、なぜ 自分の 機能を追加してほしいのかを説明してください。
トピックの本文では、リクエストする機能を簡潔に述べます。具体的かつ説明的にし、曖昧またはオープンエンドな表現を避けてください。
コンテキストと説明を提供する
機能リクエストのコンテキストと説明を提供します。
- リクエストする機能の明確な説明
- 現在の苦労している問題点やユースケース、および自分の機能がそれをどのように解決するか
- 調査した関連する背景情報やリサーチ
例とスクリーンショットを提供する（オプション）
該当する場合は、機能リクエストを説明するために例、モックアップ、またはスクリーンショットを提供して、他の人があなたのアイデアを簡単に視覚化できるようにします。
コミュニティと関わる
機能リクエストを作成したら、質問やフィードバックに返信するなどしてメンバーと関わってください。これにより、リクエストが検討される可能性が高まります。
次に予想されること
機能リクエストを送信すると、コミュニティと Discourse チームによってレビューされます。以下が予想されます。
- コミュニティからのフィードバックとディスカッション
- リクエストが実現可能であり、検討中であることを示す Discourse スタッフからの返信
- 将来のアップデートでの機能リクエストの潜在的な実装
機能を実現させたいですか？
場合によっては、機能リクエストがコアに適していないことがあります。機能の決定がどのように行われるか を読むことができます。自分で機能を開発できない場合でも、実現の可能性を高める方法はまだあります。
discourse.org の顧客になる
私たちと一緒にサイトをホストすることで開発資金を提供したい場合（お客様のリクエストは開発スケジュールで常に優先されます）、それがより早く実現する1つの方法です。エンタープライズのお客様 は、コアチームに時間単位の料金でカスタム機能（通常はプラグインの形式）をリクエストできます。
「pr-welcome」タスクのスポンサーになる
pr-welcome トピックの包括的なリストがあります。これらは、私たちが完了したいと考えているが、現在自分たちで作業する時間的余裕がないタスクです。これらのタスクに取り組む誰かにスポンサーをすることは、参加するための素晴らしい方法であり、Discourse への貢献 はすべて大いに歓迎されます。
マーケットプレイスで有料の作業をオファーする
ビジネスにとって不可欠なプラグインがある場合は、Marketplace で有料の依頼を宣伝します。スクリーンショットや予算など、できるだけ多くの詳細を提供します。「ワンタイムインストール」や「パーソナライズされたテーマ」などの標準化されたマイクロサービスを提供しているフリーランサーを見つけることもできます。
全体
一般的なすべきこととすべきでないこと
すべきこと
- リクエストは簡潔にし、単一の機能に焦点を当てる
- 実装や技術的な詳細について仮定を立てない
- コミュニティのフィードバックに基づいてアイデアを妥協し、適応させる意欲を示す
すべきでないこと
- 1つのトピックに複数の機能を含める
- リクエストの範囲について他の人に疑問を抱かせる
FAQ
Q: 詳細な機能リクエストを作成する時間がない場合はどうすればよいですか？
A: その場で詳細なリクエストを作成できない場合は、言いたいことを考え直し、後でもう一度試してください。これにより、最善の主張を提示でき、他の人がリクエストをサポートし、追加される可能性が高まります。
Q: 機能リクエストはどこに投稿すべきですか？
A: 適切なカテゴリを使用してください - 機能リクエストは Feature カテゴリに投稿する必要があります。
Q: リクエストに使用するタグがわからない場合はどうすればよいですか？
A: タグはプラグインやテーマコンポーネントの名前と一致して使いやすいようになっていますが、トピックが空白のままである場合、チームメンバーまたは Regular が適切なタグをトピックに追加します。
リクエストでは敬意を払い、オープンマインドで臨んでください。機能リクエストを不満を表明するために使用しないでください。不適切な言葉遣いや行動は、リクエストの遅延または無視につながる可能性があります。
追加リソース
- カテゴリ: Feature, Marketplace, Plugin, Plugin > Extras, Theme, Theme component
- タグ: current-projects, release-notes, pr-welcome, planned
- https://meta.stackexchange.com/questions/258136/how-do-i-write-a-good-feature-request
- How do we decide what goes into each release of Discourse?
- Discourse pricing | Discourse - Civilized Discussion
