Contribution Rules

Feature

• Todoをissueとして挙げていく
• それらを以下のProjectsでTodoリスト管理する。
  • https://github.com/dlopp/question-box/projects/1
• 作ってるときはIn progress
• 終わったらdoneに持ってく

Branch

• mainブランチから、開発ブランチを切る。
• 簡単な修正ぐらいやったらmainにそのままでok

    # mainブランチに移動
      git switch main
    # branchを切る
    # git switch -c username/featureまたはhotfix/issue番号_作業内容(英語で単語区切りはアンダーバー)
    # 該当issueがない場合は、issue番号省くかissue立てるかしてください。
    # 例
      git switch -c "Daaiki/feature/#1_create_answer_detail_page"
      git switch -c "yuto14prog/hotfix/#2_fix_page_layouts"
  

• ブランチ名のルール
  • feature ... 新規開発ブランチ
  • refactor ... 機能開発以外の変更
  • hotfix ... issueとかのbugfixブランチ

Commit

• git-czを使う。

    git add filename
    git cz
    # 対話が始まります。該当する内容がない場合はenterを押すことでskipできます。
    # 対話中にコミットやめたくなったら、ctrl + c で対話から抜けられます。
  

• 日本語 japanese!!

Pull Request

参考：チーム開発におけるプルリクエストの作法

本文には以下のようなことをMarkdownの見出しにして書くと便利です。

• 目的
• 達成条件
• 実装の概要
• レビューして欲しいところ
  • ここはこうしたけどこの点で問題はないだろうか
  • このあたりいじってるけど特に悪いことはないか
• 不安に思っていること
  • 何をレビューしてほしいかを書こう
  • 設計や企画のレビュー
• 保留してること
  • このプルリクでしないこと
  • レビューの範囲を絞れる
• スケジュール
• マージすべき日、リリースすべき日の指定があれば書く
• 関連
  • 関係するプルリクエスト

Cycle of Git

1. GitHubからclone
2. 依存関係のインストール
3. ブランチを切る
4. 変更する
5. ステージングに移す
6. コミット
7. 4～6 を繰り返す
8. 終わったらpush
9. プルリクエスト作成
10. okが出るまで 4～6 繰り返しつつpush
11. マージされたら、mainブランチに戻る
12. fetch
13. pull
14. branchを消す
15. 3に戻る 適宜誰かのプルリクがマージされたらfetch and pull

  # 1
  git clone url
  # 2
  yarn
  # 3
  git switch -c "ブランチ名"
  # 4
  # 5
  git add 変更したfilename
  # 6
  git cz
  # 7
  # 8
  git push origin HEAD
  # 9
  # 10
  # 11
  git switch main
  # 12
  git fetch
  # 13
  git pull origin main
  # 14 
  git branch -d "切ったブランチ名"