🐷

個人開発に Github の PR Template 機能を使ったら生産性上がった

に公開
Git
GitHub
tech

はじめに

皆さん、Github の標準機能として用意されている PR テンプレート機能を使っていますか？
PR を作成した時に自動でテンプレートが反映されるこれです↓

この、PR テンプレート機能を活用すれば、

  • 作業効率が向上
  • シンプルに楽
  • 後から見た際、同じフォーマットなので見やすい

などのメリットが挙げられます。
とても簡単に出来るのでこれを機会にぜひ！

PR テンプレートの設定方法

GitHub で PR テンプレートを設定する方法は簡単です。
プロジェクトのルートに .github フォルダを作成し、その中に pull_request_template.md ファイルを作成するだけで OK です。

1. ファイルの作成

your-project/
├── .github/
│   └── pull_request_template.md

2. テンプレートの作成

ここでは例として、以下のようなテンプレートを作成します。

## 変更内容

### 概要

この PR で何を変更したかを簡潔に説明してください。

### 変更の種類

該当する項目にチェックを入れてください

- [ ] 新機能 (feat)
- [ ] バグ修正 (fix)
- [ ] ドキュメント更新 (docs)
- [ ] スタイル変更 (style)
- [ ] リファクタリング (refactor)
- [ ] パフォーマンス改善 (perf)
- [ ] テスト追加/修正 (test)
- [ ] ビルドツール/設定変更 (chore)

## 変更詳細

### 追加された機能

- 機能 A の実装
- 機能 B の実装

### 修正された問題

- 問題 A の修正
- 問題 B の修正

## 関連 Issue

- Closes #[issue 番号]

## スクリーンショット・デモ

### Before (変更前)

![Before](URL_TO_SCREENSHOT_OR_DEMO)

### After (変更後)

![After](URL_TO_SCREENSHOT_OR_DEMO)

## 動作確認

- [ ] ローカル環境での動作確認
- [ ] 正常系のテスト
- [ ] 既存機能に影響がないことの確認

## 備考

その他、メモしておきたい情報があれば記載してください。

動作

下図の様にテンプレートが反映しています。
これで今後 PR を作る時、中身の部分だけ変えれば良いです。

終わり。

参考リンク

https://docs.github.com/ja/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository

Discussion