How to use Git
- Visual Studio Codeのインストール
分散型バージョン管理システムって呼ばれるやつだね。
それだけ言われてもピンとこないと思うけど、要はソースコードを各開発者が自分のPCに保持して開発できて、どの時にどこを変更したって情報のバックアップをすることができるよ。
- ファイルの共有
- ファイルのバックアップ
- 複数人のファイルの同期
- 複数人でのファイルの安全な編集
安全な編集っていうのは例えば、複数人で同じファイルを弄ったとき普通だったら手作業で纏めるか、片方をなかったことにするしかないんだけど、Gitを使うと基本的に自動で纏めてくれるよ。
Gitは上で言った通り分散型バージョン管理システムの名称だね。
GitHubはGitを使った開発プロジェクトの為のウェブサービスだね。 バージョン管理やプロジェクトの開発の為のいろいろな機能が備わってるよ。
| 用語 | 意味 |
|---|---|
| Repository (リポジトリ) |
データを保存してるところの総称だね |
| Remote Repository (リモートリポジトリ) |
サーバー上のリポジトリだね ここからローカルリポジトリにソースコードを持ってきて開発するよ |
| Local Repository (ローカルリポジトリ) |
自分のPC上のリポジトリだね ここで開発してリモートリポジトリにデータを送ってあげるよ |
| Clone (クローン) |
リポジトリをローカルに引っ張ってきたりすることだよ |
GitHubへ行ってアカウント登録を済ませてね。
プランはFreeのもので大丈夫だよ。
TSBの開発者はこの時登録したアカウントをDiscordで伝えてね
公式サイトに行ってインストーラーをダウンロードしてね
インストーラーの設定は基本的に全部飛ばしても大丈夫だよ。
Git Bashを起動して下記のコマンドを打ってね。
$ git --version$ git config --global user.name <GitHubに登録したユーザー名>$ git config --global user.email <メールアドレス>※ここから先はTSB開発者用の説明だよ。もし、TSB開発者ではないけど見てる人ならここらへんのブログを見てね
ここからはVSCodeで作業するよ。下記の手順に従ってやってみてね。
-
まずVSCodeを起動するよ
-
そしたら
Ctrl + Shift + Pを押して検索欄にgit cloneと入力して出てくるGit: クローンを選択してね
-
そしたらリポジトリURLを入力できる欄があるからそこに
https://github.com/TheSkyBlock/TheSkyBlock.gitを入力してEnter
ほい。これでローカルリポジトリを作ることができたよ これで開発できるね！
| 用語 | 意味 |
|---|---|
| Branch (ブランチ) |
主流から伸びる支流みたいに分岐して管理できるよ そのブランチで開発してもほかのブランチには影響しないよ |
| Commit (コミット) |
開発したものをローカルリポジトリに記録することだよ |
| Push (プッシュ) |
ローカルリポジトリの開発の記録や内容をリモートリポジトリに反映させることだよ |
| Pull (プル) |
リモートリポジトリ側に保存されてる開発の記録や内容をローカルリポジトリに反映させることだよ |
| Merge (マージ) |
ブランチAにブランチBの内容を反映することだよ |
| Conflict (コンフリクト) |
ローカルリポジトリとリモートリポジトリでファイルの同じ個所に変更があって自動で纏めれないこと こうなっちゃうと手動で変更するしかないの |
| Pull Request (プルリクエスト) |
他のブランチにこのブランチをmergeしてね ってリクエストすることだよ コミットから参照したり紐づけて閉じたりもできるよ |
| Issue (イシュー) |
既知の問題やタスク等を管理できるやつだよ コミットから参照したり紐づけて閉じたりもできるよ |
-
クローンしたフォルダをVSCodeで開く
-
ブランチを切る
-
ステータスバーの左下に
masterと書かれている部分があるのでそこをクリック
注: 2回目以降の場合左下をmasterブランチに変更してから下記の操作を行ってね -
上に
チェックアウトする参照を選択と表示されるので+ 新しい分岐の作成...を選択 -
新しいブランチ名を入力することができるので神器の場合は
dev/<自分の名前>_<神器ID>と入力する
e.g.dev/chen_0001,dev/haru_0256
-
-
機能の開発やバグ修正を行う
神器の開発方法はこちら -
編集したファイルをコミットする
-
サイドバーからソース管理に移動する(画像参照)
-
メッセージ欄に開発の概要を書き込む
(ただし、複数の処理の変更や追加は行わず、一つの事柄についてを書き込む) -
その開発やバグ修正で変更されたファイル類がメッセージ欄の下に表示されているのでそれらを
+ボタンでステージ
(そのコミットにそのファイルを含めることをステージと言うよ) -
メッセージ欄の上にあるチェックマークのボタン押してコミット
-
-
ステータスバー左下のブランチ名が書かれているところの一つ右にあるマークをクリックしてリモートリポジトリにプッシュ(画像参照)
-
GitHubのリポジトリにアクセスすると画像のような表示が出ているはずなので
Compare & pull requestをクリック
[出てなかった場合]Pull requestsのタブへ行きNew pull requestを押す
[base: master ▼] <- [compare: master ▼] みたいになっている場所があるからcompareに自分のブランチを指定してね -
次のような画面になるのでタイトルと必要があればコメントを書いて
Create pull requestをクリックしてプルリクエストは完了だよ
-
ブランチを最新の状態に更新する場合
Core側になんらかの更新が入り、それを神器の作成中に使う必要がある場合は以下の操作を行ってね
ウィンドウ上部のメニュー -> ターミナル(T) -> タスクの実行... -> Master Merge これでブランチを最新の状態に更新できるよ -
プルリクエストが
Changes Requestedの状態になることがあるよ
これはそのプルリクエストでの変更に問題があるから修正してねって状態だよ 問題点は列挙されてると思うからそれに沿って修正してね
修正した後は画面右にあるサイクルマークを押してRe-request reviewしてね(画像参照)
参考にさせていただいたページ