Minge2021Winter_Team3

2021冬みんげーチーム3

GitHub の使い方

Issueを作るとき

1. New issue ボタンを押す

ISSUE_TEMPLATE が用意されているため、次のような画面に移る。作りたい方の issue を作る。

2. Feature request の Get started ボタンを押す

次のような画面になる。

[FEATURE] は消さずにタイトルを入力し、提案の詳細などをその下の入力欄に書き入れる。

入力し終わったら Submit new issue ボタンを押す。

3. 作られているか確認する

次のように作られていればOK

ブランチの命名規則

• feature の場合 feature/#ここにissue番号/issueの内容
• bug の場合 bug/#ここにissue番号/issueの内容

例.

• feature/#1/update-readme
• bug/#2/fix-hoge-file

ローカルで行うこと

# ブランチを作る(シングルクォーテーションは環境によってはいらないかも)
git branch 'feature/#1/update-readme'
# 作ったブランチに移動する(シングルクォーテーションは環境によってはいらないかも)
git checkout 'feature/#1/update-readme'

git commit をするとき

とくに指定はないけど、コミットメッセージに issue 番号を付けるとうれしい（なくてもいい）

例.

git commit -m "Update README.md, #1"

git push をするとき

git add して git commit したあと。

自分の作業しているブランチと同じ名前のリモートブランチにpushする。

git push origin ブランチ名

# 例
# git push origin feature/#1/update-readme

Pull request を作るとき

※なにかを更新したとき前提

1. push すると以下のような緑色の表示が出てくる

2. Compare & pull request を押す

タイトルをいい感じに日本語に直す

例.

• README.md の修正

下の入力欄に変更内容などを入力する
出来たら Create pull request を押す

3. 作られているか確認する

Reviewersに誰かを指定してもいい。

他の人にレビューをしてもらったり、OKをもらったら main ブランチにマージする。

4. Merge pull request を押す おつかれさまでした！

別々のOSで開発するとき

別々のOSの人が集まってゲームを作成するとき、文字コードの関係でエラーが起きます。
そのため、チームメンバー全員が

• nkfコマンドのインストール
• pre-commitを.git/hooks/に移動

を行ってください。