【GitHub入門】Issueで仕様変更を提案する|CoinCollector発展制作の準備(1コマ)
この記事は、4人で作るコイン収集ゲームの発展制作に入る前の練習です。1コマ(50分)で、Issueを作り、チームで話し合い、PRとつないでCloseするところまで進めます。
準備
- 「4人で作るコイン収集ゲーム」で使った、チーム用のリポジトリ(CoinCollector)を、ブラウザでGitHubから開きます。
- 画面の上のほうに「Issues」タブが見えることを確認します。
- チームの全員が、同じリポジトリのメンバー(Collaborator)になっていることを確認します。
ゴール:自分のチームのリポジトリで、Issueを1件作り、話し合い、Closeまで進めます。
1. Issueとは
Issue(イシュー)は、GitHubで「やりたいこと」や「相談したいこと」を書いて、チームで共有する場所です。チャットで決めたことも、Issueに1行残しておけば、休んだ人や後から参加した人も同じ内容を確認できます。
2. 練習1:Issueを作る
- リポジトリの「Issues」タブを開きます。
- 緑の「New issue」ボタンを押します。
- Title(題名)と本文を書きます。
- 画面右下の緑のボタン(「Create」または「Submit new issue」と表示されます)を押します。
作られたIssueには、#1、#2のような番号がつきます。この番号は、あとでPRとつなぐときに使います。
考えてみよう:Issueの一覧にはタイトルだけが並びます。次の3つのうち、開かなくても内容が分かるタイトルはどれでしょう。
- 変更したい
- 画面の文字について
- Restartボタンの文字を日本語にする提案
答えを見る
3つ目です。一覧にはタイトルだけが並ぶので、「何を」「どうしたいか」が書いてあると、開かなくても内容が分かります。
3. 練習2:仕様変更の提案を書く
提案は、次の4項目で書くと、読む人が判断しやすくなります。
## 今の仕様
## 変更案
## 理由
## 影響しそうなところ
たとえば、Restartボタンの文字を日本語にしたい場合は、次のように書きます。
タイトル:Restartボタンの文字を日本語にする提案
## 今の仕様
Restartボタンの文字は「Restart」です。
## 変更案
「もう一度遊ぶ」に変えます。
## 理由
日本語のほうが、遊ぶ人に伝わりやすいと思います。
## 影響しそうなところ
(ここは、次の「考えてみよう」で書いてみましょう)
考えてみよう:「影響しそうなところ」には、何を書くとよいでしょう。ボタンの文字を変えると、誰の作業に関わるかを考えてみます。
答えを見る
日本語を表示するには、その文字を含むTMP Font Assetを用意します(作り方は、別記事の「TextMeshProで日本語を表示するチュートリアル」にあります)。
UIを担当するCの作業と、HUDをシーンへつなぐAの確認にも関わります。テストで確認する文字も「Restart」から変わります。
それでは、自分のチームのリポジトリで、このIssueを作ってみましょう。
4. 練習3:コメントで話し合い、合意を残す
Issueの下にあるコメント欄で、チームで話し合います。
- 賛成や質問は、コメントで書きます。
- 全員が納得したら、決まった内容を1行のコメントで残します。例:「決定:Restartを『もう一度遊ぶ』に変更する。担当はC。」
- 講師の確認が必要な内容は、コメントで講師にも伝えます。
決定をIssueに残しておくと、あとから「いつ・誰が・なぜ変えたか」を読み返せます。
5. 練習4:PRとIssueをつなぐ
変更を実装したPRの本文に、次のように書きます。#のあとの数字は、つなぎたいIssueの番号です。
Closes #3
こう書いておくと、PRをmainにマージしたときに、そのIssueが自動でCloseされます。GitHub Desktopでは、「Create Pull Request」を押すとブラウザが開くので、そこでPRの本文に書きます。マージのあと、Issueが「Closed」になっていることを確認しましょう。
6. まとめ
- Issueに提案を書く(今の仕様、変更案、理由、影響しそうなところ)
- コメントで話し合い、決まった内容を残す
- 別のブランチで実装し、PRで「Closes #番号」と書く
- マージすると、Issueが自動でCloseされる
発展制作では、追加機能や仕様の変更を、この流れで進めます。








ディスカッション
コメント一覧
まだ、コメントがありません