GitHub はコラボレーション プラットフォーム
コラボレーションは GitHub が行うあらゆるものの中核です。 このモジュールの最初のユニットでリポジトリについて調べ、リポジトリがプロジェクトとそのファイルの整理に役立つことを学習しました。 直前のユニットでは、プロジェクトに加えられた変更を追跡する方法である pull request について学習しました。
このユニットでは、問題とディスカッションについて学習します。 これらは、GitHub Enterprise Platform のコラボレーションの性質に寄与する機能です。
問題
GitHub の問題は、GitHub で作業するためのアイデア、フィードバック、タスク、またはバグを追跡するために使用されます。 issue はさまざまな方法で作成できるため、ワークフローに最も便利な方法を選択できます。
このチュートリアルでは、リポジトリから問題を作成する方法について説明します。 問題は、次の場所から作成することもできます。
- タスク リスト内の項目。
- プロジェクト内のノート。
- issue または pull request 内のコメント。
- 特定のコード行。
- URL クエリ。
リポジトリからの Issue の作成
GitHub.com で、リポジトリのメイン ページに移動します。
リポジトリ名の下にある、[Issues] を選択します。
[New issue] (新しい issue) を選択します。
リポジトリで issue テンプレートが使用されている場合は、開きたい issue の種類の横にある [作業の開始] を選択します。
開きたい issue の種類が選択可能なオプションに含まれていない場合は、[Open a blank issue] (空の issue を開く) を選択します。 テンプレートを使用しない場合は、手順 5 に進みます。
リポジトリで問題フォームを使用している場合は、空の問題テンプレートではなく、入力する構造化されたフォームが表示されます。 問題フォームを使用すると、保守担当者は標準化された形式で特定の情報を収集できます。
[タイトルの追加] フィールドに、issue のタイトルを入力します。
[説明を追加する] フィールドに、issue の説明を入力します。
プロジェクトのメンテナは、Issue を他のユーザーに割り当てたり、プロジェクト ボードに追加したり、マイルストーンに関連付けたり、ラベルを適用したりできます。
入力が終わったら、[新しい issue を送信] を選びます。
ラベル、メンション、リアクションを使用してコラボレーションを効果的に管理し、問題の可視性を高めます。 問題テンプレートは、共同作成者に対する一貫した構造と期待を維持するのに役立ちます。
一部の会話は、GitHub ディスカッションに適している場合があります。 GitHub ディスカッションを使用して、質問と回答、情報の共有、お知らせの作成、プロジェクトに関する会話の実施または参加を行います。
次のセクションでは、Discussions と、この機能を最適に利用する方法を確認します。
ディスカッション
ディスカッションは、必ずしもコードに関連付けられていない会話 (Q&A、アイデア、一般的なフィードバックなど) 用に設計されています。 共有フォーラム内でオープンで継続的な通信をサポートし、リポジトリの可視性に応じてパブリックまたはプライベートにすることができます。
このセクションでは、以下の方法について説明します。
- リポジトリ内で discussion を有効にします。
- 新しい discussion と discussion のさまざまなカテゴリを作成します。
では、リポジトリ内での discussion の有効化について詳しく見てみることにしましょう。
リポジトリ内での discussion の有効化
リポジトリの所有者と書き込みアクセス権を持つユーザーは、パブリック リポジトリとプライベート リポジトリのコミュニティに対して GitHub ディスカッションを有効にすることができます。 ディスカッションの可視性は、作成されたリポジトリから可視性を継承します。
GitHub ディスカッションを初めて有効にすると、ウェルカム 投稿を構成するように求められます。
GitHub.com で、リポジトリのメイン ページに移動します。
リポジトリ名の下で、[設定] を選択します。
[機能] セクションまで下にスクロールし、[Discussions] の下で [discussion の設定] を選択します。
[ 新しいディスカッションを開始する] で、コミュニティのトーンとリソースに合わせてテンプレートを編集します。
[Start discussion] (discussion を開始) を選択します。
以上で、新しい discussion を作成する準備ができました。
新しい discussion を作成する
リポジトリを表示できる認証されたユーザーが、そのリポジトリで discussion を作成できます。 組織レベルのディスカッションでは、ソース リポジトリを表示できるすべてのユーザーがディスカッションを作成することもできます。
GitHub.com で、discussion を開始するリポジトリまたは organization のメイン ページに移動します。
リポジトリ名または organization 名の下にある [Discussions] を選択します。
ページの右側で [New discussion] (新しい discussion) を選択します。
[ 作業の開始] を選択して、ディスカッション カテゴリを選択します。 すべてのディスカッションはカテゴリに配置する必要があります。 リポジトリの保守管理者は、これらのカテゴリを定義します。
各ディスカッション カテゴリには、目的を明確にするための一意の名前、絵文字、説明が含まれています。 カテゴリは、保守担当者が会話の登録方法を整理するのに役立ちます。 これらは、Q&A、またはより自由な回答式の会話であるカテゴリが区別しやすくなるようにカスタマイズできます。 次の表は、discussion の既定のカテゴリとその目的を示しています。
| カテゴリ | 目的 | 形式 |
|---|---|---|
| 📣 お知らせ | プロジェクトのメンテナからの更新とニュース | Announcement |
| #️⃣ 全般 | プロジェクトに関連するすべての事柄 | 自由回答式の discussion |
| 💡 アイデア | プロジェクトを変更または改善するためのアイデア | 自由回答式の discussion |
| 🗳️ 投票 | コミュニティが意見を表明したり議論したりするための複数のオプションを含む投票 | 投票 |
| 🙏 質疑応答 | コミュニティが回答する質問 (質問/回答形式) | 質問と回答 |
| 🙌 表示と通知 | プロジェクトに関連する作成物、実験、またはテスト | 自由回答式の discussion |
リポジトリの保守担当者は、可視性を向上させるために、重要なディスカッションを [ディスカッション] タブの上部にピン留めできます。
[discussion のタイトル] の下に、discussion のタイトルを入力し、[書き込み] の下に、discussion の本文を入力します。
[Start discussion] (discussion を開始) を選択します。
これは、問題とディスカッションを通じて GitHub がコラボレーションをサポートする方法について説明します。 次に、通知の管理、スレッドへのサブスクライブ、GitHub ページの使用を開始する方法に進みましょう。
コメントを回答としてマークする
Q&A スタイルのディスカッションでは、コメントを元の質問に対して受け入れられた回答としてマークできます。
- ディスカッションに移動します。
- 元の質問に最も適したコメントを見つけます。
- コメントの下にある [回答としてマーク] を選択します。
コメントが強調表示され、他のユーザーが簡単にソリューションを見つけることができます。 必要に応じて、回答のマークを解除することもできます。
ディスカッションを問題に変換する
ディスカッションが追跡する必要がある作業につながる場合は、ディスカッションを問題に変換できます。
- 変換するディスカッションに移動します。
- ディスカッションの右上にある
...(3 つのドット) メニューを選択します。 - [Issue に変換] を選択します。
- 変換を確認し、新しい問題を作成するリポジトリを選択します。
これにより、コミュニティの会話から発生した実用的な作業が追跡されます。
discussion をピン留めする
重要なディスカッションを [ディスカッション] ページの上部にピン留めして、可視性を高めることができます。
- ピン留めするディスカッションに移動します。
- ディスカッションの右上にある
...(3 つのドット) メニューを選択します。 - [discussion をピン留めする] を選択します。
ピン留めされたディスカッションは、コミュニティが注目すべきお知らせ、重要な質問、または進行中のトピックを強調表示するのに役立ちます。