このレポジトリーは？
このレポジトリーはAIスペイン語学習アプリを共同開発用レポジトリです。
ブランチ戦略
ブランチ戦略とは、ブランチの切り方のルールです。 ブランチの切り方のルールを定める理由はシンプルで、意図しないmainブラントへのpushを避けることです。 間違えて直Pushした時の元に戻している時間ほど無駄なことはありまあせん。TickTokスクロールしてた方が有益です。 以下リモートブランチにpushするまでの手順です。
①mainブランチ上でリモートブランチトと同期します。
git pull
②feature/<なんとなく推測できる変更内容の英字>でブランチをチェックアウトします。
例: readmeを追加した場合。
git checkout -b feature/add-reaedme
③変更ファイルを確認。
git status
④変更内容をステージングする。※不要なファイル追加を防ぐため基本的にgit add .でなく直接ファイルパスを指定しましょう。
git add <ファイルパス>
⑤変更内容をコミット。
git commit -m <なんとなく変更内容がわかる一文>
⑥リモートブランチにpush ※最初のpush時は上流ブランチをセットしてください的なエラーと推奨コマンドが出ると思うのでそれを実行しましょう。
git push
ここまで完了したら次にPR(Pull Request)を出しましょう。
PRの出し方
1 Compare & Pull Requestをクリック。
2 適当な文章を入れる。
3 マージても大丈夫そうならマージをクリック。
4 マージできたら完了。
PRのレビューについて
基本はお互いにレビューを求めず、PRを作成したらそのままmainブランチにマージしましょう。
これはお互いのレビュー待ちに起因するフラストレーションと開発効率を上げるためです。(まぁーそもそも二人だけだし、、)
将来的にはpushしたら自動でコードを整形してくれるlintやLLMにコードレビューしてもらう的な機能も入れたいですがそれはおいおいで。
タスク管理について
基本タスクは全てissueベースで管理しましょう。
これはお互いが今何をどれぐらい進められているかを把握するためです。
何かアプリに追加や修正を加える場合はissueを作成しましょう。
とは言ってもめちゃくちゃ小さい修正,タイポの修正やコメント修正などのためにいちいちissueを作成するのは面倒なのでその場合はスキップしましょう。
issue作成の仕方。
1
2 適当なタイトルと説明を追加しましょう。
3 完了したらcloseしましょう。