やりたかったこと

GitHubのIssueとPull Requestを使ってチーム開発の流れを理解したかった。

環境

  • GitHub

Issueとは

バグ報告・機能要望・タスク管理に使う。

Issueを作成する

  1. GitHubのリポジトリページを開く
  2. 「Issues」タブ→「New issue」
  3. タイトルと説明を入力して「Submit new issue」

よく使うIssueのテンプレート

## 症状
どんな問題が起きているか

## 再現手順
1. 
2. 
3. 

## 期待する動作
どうなるべきか

## 環境
- OS：
- バージョン：

Pull Requestとは

コードの変更をレビューしてもらってからマージする仕組み。

Pull Requestの流れ

# 1. ブランチを作成
git switch -c feature/fix-bug

# 2. 変更してコミット
git add .
git commit -m "fix: バグを修正"

# 3. GitHubにpush
git push -u origin feature/fix-bug
  1. GitHubでPull Requestを作成
  2. レビューしてもらう
  3. 承認されたらマージ

Pull RequestとIssueを紐付ける

コミットメッセージやPRの説明に以下を書くと自動でIssueが閉じる。

fix #123
closes #123
resolves #123

ハマったポイント

  • Issueの番号はPRと自動紐付けできる
  • レビューなしでmainに直接pushするのは避ける
  • ブランチ名はわかりやすく付ける

Pull Requestのブランチ管理に慣れたら、git rebaseの基本的な使い方でコミット履歴を整理してからPRを出すと、レビュワーが変更内容を追いやすくなる。

関連記事

おすすめのVPS