Githubを使ったファイル変更の手順 - TUSB/TheUnusualSkyBlock GitHub Wiki
Githubを使ってファイル変更をする際の手順をまとめる
https://github.com/TUSB/TheUnusualSkyBlock/issues にアクセスする。
右上にある「New Issue」をクリックする。
このような画面が表示されるので、上から3つのうち目的に合ったものを選択する。今回は「開発用のタスク」で進める。
入力フォームに沿って入力する。入力が完了したら、左下の「Create Issue」をクリックするとIssueが作成される。
これらの設定は、歯車マークを押すことで変更できる。
Assigneesは担当者を設定する場所。
Labelsはラベルを設定する場所。開発バージョンのタグ、優先度に合ったタグをつける。自身が開発しない/できない場合には「担当募集」タグをつける。
Typeは種類を示す場所。Bugはバグ報告に、Featureはアイデア、機能開発の場合につける。
ProjectはIssueの進捗状況をまとめる機能。bug、feature、ideaのうち対応したものを付け、Statusを「開発進行中」にする。
※ここではGithubブラウザでの作業手順を示すが、VSCodeから作成することもできる。
作成したIssueの右下にある「Create a branch」をクリックする。
「Branch name」の下にブランチ名を入力する。ブランチ名の規則はここを参照。
「Branch source」は基本的にそのままでよい。 1.19.4の修正と1.21.1の開発を同時に進める際など、開発環境によって別のブランチを基にすることがある。ブランチの変え忘れに注意。
設定が終わったら、右下の「Create Branch」をクリックするとブランチが作成される。
ここからはVSCodeで作業する。
Ctrl+Shift+Gを押すか、ボタンをクリックしてソース管理の画面を開く。
変更の右側にある「その他の操作」（3点リーダー）をクリックして、さらに「フェッチ」を押す。すると、現在のリモートリポジトリの状態がローカルリポジトリ（自分のPC側）に反映される。
左下のブランチ名（この画像ではfeature/knight-phalanx）をクリックする。画像のようにブランチの一覧が表示されるので、「origin/（先程のブランチ名）」をクリックする。
先程の画像の場所に戻って「プル」を押す。すると、ファイルが現在の最新に更新される。
開発を進める。この際、ファイルを追加/削除/移動/名前の変更をした場合は以下の手順を実行する必要がある。
Ctrl+Shift+@もしくは上の「ターミナル」→「新しいターミナル」を開き、「git add -A」と入力してEnter。これでファイルの変更が正常に反映される。
開発が終了したら、ソース管理の画面を開いてコミットに使う変更を選んでいく。「1コミット=1要素(1 ロジック)の変更であるべき」なので、それに沿って分割する。
今回は隼斬りだが、skill:act以下にあるものとmakeup:skill/act以下にあるもので二つに分割した。
Exportツールを使用していると差分が多くなるが、これらは一か所に固まっている。一番上/一番下を探せば自分で変更した部分が見つかるだろう。
ファイル名の右端にある+マークを押すと変更がステージされ、コミットに含まれるようになる。間違ったら-マークでステージング解除しよう。1要素に関わるファイルを全てステージしたら、コミットメッセージを入力しよう。コミットメッセージの規則はここを参照。
「コミット」を押すとコミットされる。あとはこれを分割した回数分繰り返すだけ。コミットが全て終了したら、フェッチやプルと同じように「プッシュ」を実行する。これでリモートリポジトリにコミットが反映される。
下の画像のようにファイルの冒頭にパスがない場合、#[半角スペース]（リソースパス）のように追加しておこう。リソースパスはフォルダタブ内でファイルを右クリック→「リソースパスをコピー」で取得できる。コミット名は「NO-ISSUE Refactor ファイルヘッダにパスを追加」でよい。
ここからはブラウザで作業する。
プッシュが終わったら、プルリクエストを作成しよう。Pull requestsのタブを開き、「New pull request」を押す。
compareに変更したブランチを、baseに基となったブランチを設定して「Create pull request」を押す。
このような画面になるので、必要事項を説明に沿って記入した上で、Issueのように右側の設定をする。ただし、Projectsを設定すると二重になってしまうので、ここでは触らない。
全て記入し終わったら、下にある「Create pull request」を押せばプルリクエストが作成される。
プルリクエストを作成したら、担当者がレビューしてくれるのを待つ。重要度が高く急いでレビューしてほしい場合には、「プリーズレビュー」のラベルを付けるとよい。
レビューを待っている状態では、右側にオレンジの丸が表示される。
プルリクエストがレビューされると、画像のようなメッセージが表示される。一枚目のように緑のチェックがついている場合には問題ないので、次の工程に移ってよい。ただし、レビュー後に小規模でない変更をした場合は再レビューが必要になる。
二枚目のように赤いファイルが表示された場合は変更が必要なので、レビューコメントを参考に修正してコミットする。レビューを再度リクエストするには三枚目のボタンを押せばよい。
全てのレビューが終了したら、画像のように表示されてマージできるようになる。マージする際は、「Squash and merge」を選択すること。それ以外に変更する点はない。
