GitとGithubの使い方 - NUTFes/FinanSu GitHub Wiki

GitとGithubの使い方

このリポジトリのルール

ブランチルール

  • mainブランチ(master)
    • 安定ブランチ，本番用ブランチ
  • developブランチ
    • 開発用ブランチ，開発段階での安定ブランチ，これを公開するときに安定ブランチにマージ
  • feature/[NAME]/[ISUEE_NUM]-[TITLE]
    • 機能の追加や変更などを行うブランチ，developブランチから派生
    • ex) feature/dodo/1-create-Dockerfile
  • fix/[NAME]/[ISUEE_NUM]-[TITLE]
    • バグの修正などを行うブランチ，developブランチから派生
    • ex) fix/dodo/2-fix-Dockerfile

コミットルール

  • コミットメッセージはissue番号を載せる
  • コミットメッセージは行った開発を端的にわかりやすく書く（長すぎないように注意する）
  • コミットメッセージラベルを付ける
    • [add] file or directory の追加
    • [mod] file or directory の編集
    • [fix] file or directory のバグや軽微な修正
    • [del] file or directory の削除
    • [otr] その他
  • ex)
    • git commit -m "[add] model group (#01)"
    • git commit -m "[fix] login page (#02)"
    • git commit -m "[mod] mypage (#03)"

基本

Githubからローカルに

Githubのリポジトリを自分のローカルに持ってくる

ローカルからGithubに

編集ファイルをステージング

  • git add <file_name or directory_name>
  • ex)
    • file: git add hogehoge/fugafuga.tsx
    • directory: git add piyopiyo

ステージングしたファイルをコミット

  • git commit -m "<commit message>"
  • ex)
    • git commit -m "[add] Dockerfile (#1)"
    • git commit -m "[fix] Dockerfileのエラー解消 (#2)"

Githubにpush

  • git push origin <branch名>
  • ex)
    • git push origin feature/dodo/1-create-Dockerfile

ブランチの切り替え

すでにあるブランチに切り替える場合

  • git switch <branch_name>
  • ex)
    • git switch feature/dodo/1-create-Dockerfile

新しいブランチを作る場合

  • git switch -c <branch_name>
  • ex)
    • git switch -c feature/dodo/1-create-Dockerfile

※ ブランチネームは空白とかは使わない，できるだけ特殊文字も使わない

ローカルのファイルにリモートの最新情報を持ってくる

  • git pull origin <branch_name>
  • ex)
    • git pull origin develop
    • git pull origin feature/dodo/1-create-Dockerfile

よし，開発しようってなったとき

  1. まず，ブランチを最新の状態にする
    git switch develop
    git pull origin develop

  2. ブランチを切ろう
    git switch -c "<feature/[NAME]/[ISSUE_NUM]-[TITLE]>"
    ex)
    git switch -c feature/dodo/1-create-Dockefile
    git switch -c fix/dodo/2-fix-Dockefile

  3. 開発をしよう
    がんばれ，応援はしてる．

  4. ステージングをしよう
    git add <編集したfile>
    ex)
    git add Dockerfile

  5. メッセージを的確につけてコミットをしよう
    git commit -m "[mod] {編集したfile} (#{issue_num})"
    ex)
    git commit -m "[add] Dockerfile (#1)" git commit -m "[mod] Dockerfile (#2)"

  6. Githubにpushしよう(開発しているブランチにpushしよう)
    git push origin <branch_name>
    ex) git push origin feature/dodo/1-create-Dockefile

  7. pull requestを行おう
    Githubにアクセスしてpull requestを行う．
    developにmergeするようにする．

おつかれ！！！

reviewをするとき

reviewって？

reviewというのはpull requestというのを送ったときに開発者以外が行う動作確認作業

gitのブランチを新しく作る

git checkout -b <適当なブランチ名(これはローカルなので好きにつけてください)
git pull origin <pull_requestされているブランチ名>

動作確認

いろいろな動作を確認

評価

大丈夫であれば

aproveをしましょう．

コードとしてなおしてほしい盤面があれば

commentをしましょう．

⚠️ **GitHub.com Fallback** ⚠️