Githubでリポジトリ用のプルリクエストテンプレートを作成する

プルリク時の記述を共通化する プルリク時に各々違うフォーマットで書かれるとレビューする人が大変なので、テンプレートを使用し共通化を図ることにした。 基本的にリポジトリ用のプルリクエストテンプレートの作成を参考にすれば間違いないが、ここでは最もシンプルな方法を共有する。 共通用テンプレートの作成 cd project-root まずはプロジェクトのルートに移動する。 mkdir .github 次に.githubフォルダを作成する。 touch PULL_REQUEST_TEMPLATE.md でPULL_REQUEST_TEMPLATE.mdという空のファイルを作成する。 そこでにテンプレート内容を書けばok。 どんなテンプレにすればいいか 正直プルリクの運用は迷うことばかりなので、プルリクのレビューを効率的に進めるためにルールを作ってみた話を参考にした。 テンプレート内容 上記リンクから内容を拝借する。 ## チケットもしくは概要 <!-- close #XX or ログイン機能の実装 --> ## やったこと <!-- - Hoge コンポーネントに props を追加 - Fuga コンポーネントを実装 --> ## 特に見て欲しいところ <!-- - 新しいライブラリを追加したが、他に妥当な物があるか - テストケースがこれで十分かどうか --> ## 動作確認手順 <!-- 1. ログインフォーム(/login)にアクセス 1. メアドとパスワードを入力してログインを実行する 1. ログインが成功してユーザー一覧ページにリダイレクトされること --> ## TODO(できればIssueを立ててリンクを貼りましょう) <!-- - [ ] バリデーション - [ ] エラーメッセージ --> ## その他情報 <!...

投稿日 · 2023-04-15 · 更新日 · 2024-06-07 · 1 分 · nove-b