GitHub初心者向け：GitHub IssuesとProjectsの始め方

GitHub for Beginners シリーズへようこそ。このシリーズは、あなたが GitHub をプロのように使いこなすお手伝いをし、その可能性を最大限に引き出すために設計されています！今回は、これらのエピソードを動画形式で共有するとともにブログにも掲載するというダブルの取り組みを通じて、あなたにとってより使いやすい形式でお届けします。 私たちは今や第 3 シーズンへと突入しました。これまでのシーズンでは、Git の全般について一般的な紹介を行い、その後は Copilot について一季まるごと議論することに注力しました。今回のシーズンでは、基本に立ち返り、GitHub の中核機能を探求していきます。私たちの目標は、あなたの GitHub スキルをレベルアップさせるか、あるいは錆びついたスキルを磨き直すお手伝いをすることです。 今回のエピソードでは、GitHub における最も強力なコラボレーションツールの 2 つである「GitHub Issues」と「Projects」から始めます。この投稿を終える頃には、Issue の作成方法、Issues を GitHub Project ボードに同期させる方法、そして GitHub Projects を活用して作業を追跡する方法をマスターしているはずです。 それでは、本題に入りましょう！あるいは、上記の完全な動画をご覧ください！ なぜ Issues と Projects が重要なのか GitHub Issues と Projects は、組織化を保ちつつ効率的にコラボレーションしたいあらゆるチームにとって不可欠なツールです。Issues を使えば、タスク、バグ、アイデアをすべて明確で共有されたスペースで追跡でき、見落としを防ぐことができます。Projects はより大きな視点から作業を見渡し、可視化、優先順位付け、計画立案を可能にし、個々の Issue を誰もが追跡できる実行可能なワークフローへと変換します。 イシューとプロジェクトを組み合わせることで、作業の調整を行い、進捗状況を共有し、全員が同じ目標に向かって一致していることを確保できます。 最初の GitHub Issue の作成 GitHub Issues は、プロジェクトで注意が必要なものを記録するためのシンプルな方法です。新しいアイデア、バグ、タスクなど何でも対象となります。これらは、プロジェクトに追加または更新したいものの基本要素と考えることができます。チームが協働して作業し、整理された状態を維持しながら、すべての項目が対応されるように支援します。 では、どのように Issue を作成すればよいのでしょうか？以下の手順に従って、実際に試すことができるサンプルリポジトリがあります。 ブラウザで gh.io/gfb-issues に移動してください。 ページの上部にある「Issues」タブをクリックしてください。 ウィンドウの右上にある緑色の「New issue」ボタンをクリックしてください。 いくつかの入力ボックスを含むウィンドウが表示されます。まず、「Add a title」の下にあるボックスにタイトルを入力して、Issue の明確なタイトルを付けてください。 「Add a description」ボックスに Issue の説明を入力してください。説明には、期待値を設定するために必要なすべての関連情報を盛り込む必要があります。誰かがこの Issue を解決しようとしたとき、追加または修正すべき動作はどのようなものですか？ ウィンドウの右側には、設定できるいくつかのオプションがあります。 Assignee: この Issue に直接取り組む人を割り当てます。自分が担当であることを示すために自分自身を割り当てることもできます。 Labels: Issue を複数の事前設計されたカテゴリのいずれかに分類するか、新しいカテゴリを追加します。 Type: このイシューがバグやタスクなどのどの種類に該当するかを示します。 Projects: このイシューをプロジェクトに追加します。これについては本記事の後半で詳しく解説します。 Milestone: このイシューを特定のマイルストーンに割り当てます。 イシュー説明の下にある緑色の Create ボタンをクリックしてください。 おめでとうございます！これで初めてのイシューが作成されました！一度イシューが作成されると、チームの誰でもコメントに参加できます。必要なことは、コメント欄にテキストを入力して Comment ボタンをクリックするだけです。また、コメント欄で # と続けてイシュー番号を入力することで、複数のイシューを相互リンクさせることも可能です。GitHub が自動的にその番号付きイシューへのクリック可能なリンクを提供します。これは関連する作業を追跡するのに非常に便利です。 そして、作業が完了したらイシューをクローズして、チーム全体に問題が解決されたことを知らせてください。 初めての GitHub プロジェクトの作成 プロジェクトを使えば、GitHub のイシューを視覚的なダッシュボード上でグループ化できます。これは計画、整理、および作業の追跡に最適なツールです。大きな目標を管理可能なタスクに分解し、すべてを一つの場所で追跡するための手段となります。 それでは、プロジェクトボードの作成手順を見ていきましょう。ここで試せるサンプルリポジトリがありますので、そちらでも構いませんし、ご自身のリポジトリで行ってもかまいません。上記の手順で開いたままのリポジトリがある場合は、最初のステップはスキップしてください。 ブラウザで gh.io/gfb-issues に移動します。 ページの上部にある Projects タブをクリックします。 ウィンドウの右上にある緑色の「New project」ボタンをクリックします。 テンプレートがいくつか表示されるポップアップウィンドウが開きます。ここで「Kanban」テンプレートを選択してください。 「Project name」フィールドにプロジェクト名を入力します。 「Bulk import items」のチェックボックスは選択解除してください。 ウィンドウ下部で「Create project」を選択します。 これで GitHub がプロジェクトを作成し、プロジェクトビューへ遷移します。ウィンドウ上部には作成したプロジェクトの名前が表示されます。また、GitHub によって自動的に列が作成されていますが、必要に応じて自由にカスタマイズできます。 プロジェクト名の直下にはいくつかのタブがあることに気づくでしょう。これらはプロジェクトボードの異なる表示モードに対応しています。各タブをクリックして、プロジェクト内でそれぞれの表示がどのように見えるか確認してみてください。 プロジェクトボードを管理するには、ウィンドウ右上隅の三点リーダー（…）をクリックし、「Settings」を選択します。これで新しいページが開き、以下のような操作が可能になります： - プロジェクトボードへのアクセス権限を持つユーザーを管理する - カスタムフィールドを作成する - 現在のフィールドを更新する - プロジェクト名を変更する - プロジェクトの説明を追加または変更する - README ファイルを含める - プロジェクトボードのコピーを作成する - プロジェクトの公開範囲（可視性）を変更する チャートをカスタマイズするには ウィンドウ上部にある「Insights」ボタンを選択します。次のページでは、チャートの表示、作成、カスタマイズが可能になります。各チャートのレイアウトは、「Configure」ボタンをクリックし、ドロップダウンメニューからオプションを選ぶことで変更できます。 ワークフローのステータスを確認するには メインウィンドウに戻ると、上部の「Insights」ボタンの隣に「Workflows」ボタンが表示されます。「Workflows」ボタンを選択してください。すると、ウィンドウの左側にいくつかの組み込みワークフローが表示され、特定のイベントに基づいて項目の状態を更新するために使用できます。例えば、プロジェクトにアイテムが追加されたときに自動的に状態を「todo」に設定したり、プロジェクト内の issue のステータスが変更されたときに issue を閉じたり、issue がクローズされたときに状態を「Done」に設定したりすることができます。 ステータス更新の追加 もう一度メインプロジェクトビューに戻り、最上部にある「Add status update」ボタンを選択してください。これにより、プロジェクトの健全性と進捗状況に関するステータスレポートを追加できるウィンドウが開きます。 issue とプロジェクトの連携 issue とプロジェクトを組み合わせることで、作業全体を包括的に把握できるようになります。issue を個別のタスクと捉え、プロジェクトをそれらのタスクを整理するダッシュボードと考えるとわかりやすいでしょう。issue をプロジェクトボードにリンクさせると、一目で全ての状況を確認できます。 すでにプロジェクトボードが開いていない場合は開いてください。ウィンドウ下部にある「Add item」を選択します。ここで新しい issue を作成することも、既存の issue を検索することも可能です。「＋」アイコンをクリックし、「Add item from repository」を選択してください。このプロジェクトボードに追加したい issue を選択します。すべてを追加する必要がある場合、リスト上部のチェックボックスを使用して一度にすべてのアイテムを自動的に選択することもできます。 追加したい課題を選択したら、ウィンドウ下部にある「Add elected items」ボタンを押してください。選択したすべての課題がカードとしてプロジェクトボードに追加される様子を確認できます。作業の進行に応じて、これらのカードを選択してステータス列の間で移動させることができます。また、課題をクリックすれば、その詳細情報をすべて確認することも可能です。 そして、ここからが面白いところです。課題とプロジェクトボードは現在同期されています。どちらか一方の課題のステータスを変更すると、他方にも自動的に反映されます。複数の課題を一度に移動させて、ワークフローに合わせた列に整理し、「Done」列へ最終的に移動させたときの達成感を味わうことができます。 エンドツーエンドの流れ 次に、チームプロジェクトで実際に使用する可能性のあるワークフローをシミュレーションするために、以下の手順を実行してみましょう。 すでにプロジェクトボードにいない場合は、まずそこに移動します。 最初の列の下部にある「Add item」をクリックし、新しい課題をワークフローに追加することを示します。 プラスアイコンをクリックして、コンテキストメニューから「Create new issue」を選択します。 追加したい新機能について説明する課題のタイトルと記述を入力します。 「Create」を選択して課題を作成し、自動的にプロジェクトボードに追加します。 記述の下にある「Labels」を選択し、オプションリストから「enhancement」を選びます。 プロジェクトボード上の課題をクリックして開きます。 右側の列で、「Assignees」の隣のギアアイコンをクリックし、チームの誰かにこの課題を割り当てます。 進捗状況の報告や更新情報の提供を示すために、イシューにコメントを追加してください。 さて、このイシューに対応する作業が完了したとしましょう。プルリクエストを開き、コメント欄でそれが関連するイシューをクローズすることを明記します。そのためには、プルリクエストの説明欄に「Closes #」と入力し、その後ろに該当するイシューの番号を入力してください。これにより自動的にイシューと接続され、参照しやすいようにリンクが提供されます。 プルリクエストをマージすると、イシューは自動的にクローズされます。 このワークフローにより、頻繁なステータス会議を行うことなく、全員が同じ認識を持つことができます。必要な情報はすべて、イシュー内およびプロジェクトボード上にあります！ 次はどうしましょうか？ これで GitHub Issues と GitHub Projects を使用して、GitHub 上で作業を整理する方法を理解しました。最初は数個のイシューから始めて、進捗に合わせてプロジェクトボードを整備していけば、チーム規模に応じて拡張できるシステムが完成します。 GitHub Issues や GitHub Projects についてさらに詳しく知りたい場合は、ぜひドキュメントをご覧ください。 Happy coding! この投稿「GitHub for Beginners: Getting started with GitHub Issues and Projects」は、The GitHub Blog で最初に公開されました。

GitHub初心者向け：GitHub IssuesとProjectsの始め方

背景や根拠まで確認しますか？

関連記事

調べる

選ぶ

サイト