GitHub Discussionsとは

GitHub Discussionsは、GitHub リポジトリの一機能で、コミュニティの共同コミュニケーションフォーラムです。GitHub Discussionsを利用することで、コミュニティメンバーは最新情報を共有したり、質問をしたり、アンケートを取ることができます。

デフォルトの状態でも十分に活用できますが、独自でカテゴリを追加することもできます。今回は、独自でカテゴリを追加した際のGitHub Discussionsのテンプレート作成方法について紹介します。

docs.github.com

GitHub Discussionsのテンプレート作成方法

(1) テンプレートを作成するDiscussionsのカテゴリ用意

Discussions ページに遷移し、カテゴリの編集ボタンを押します。
カテゴリを作成します。
カテゴリを登録します。今回はカテゴリ名をArchitecture Decision Recordとします。

(2) テンプレートファイル作成

まず、/.github/DISCUSSION_TEMPLATE/ ディレクトリを用意します。

/.github/DISCUSSION_TEMPLATE/ ディレクトリ配下に、(1)で用意したカテゴリの名でテンプレートファイルを作成します。今回の場合は、カテゴリ名がArchitecture Decision Recordなので、/.github/DISCUSSION_TEMPLATE/architecture-decision-record.ymlになります。

テンプレートファイルの書き方は、公式のドキュメントを参照ください。

ディスカッションカテゴリフォームの構文 - GitHub Docs

今回の場合は以下のように作成しました。

labels: [Architecture Decision Record]
body:
  - type: dropdown
    attributes:
      label: ステータス
      description: この文書のステータスを選択してください。
      options:
        - "提案済み"
        - "承認済み"
        - "破棄"
    validations:
      required: true
  - type: textarea
    attributes:
      label: コンテキスト
      description: この決定を行った状況について書いてください。
    validations:
      required: true
  - type: textarea
    attributes:
      label: 決定
      description: 決定とその根拠について書いてください。
    validations:
      required: true
  - type: textarea
    attributes:
      label: 影響
      description: 決定による影響や、比較・検討した内容について書いてください。
    validations:
      required: true
  - type: textarea
    attributes:
      label: コンプライアンス
      description: この決定が順守されていることを確認方法について書いてください。
    validations:
      required: true
  - type: textarea
    attributes:
      label: 備考
      description: 参考文献等あれば書いてください。
    validations:
      required: false