Skip to content

Comments

GitHub の PR テンプレートを導入する#96

Open
f-yoshihara wants to merge 6 commits intomasterfrom
add-pr-template
Open

GitHub の PR テンプレートを導入する#96
f-yoshihara wants to merge 6 commits intomasterfrom
add-pr-template

Conversation

@f-yoshihara
Copy link
Contributor

@f-yoshihara f-yoshihara commented Nov 18, 2025

やったこと

GitHubのPRテンプレート (.github/pull_request_template.md) を新規追加しました。

このPRがマージされるとうれしい理由

  • PRの品質向上とレビューの効率化
  • PRのdescriptionに一般的なチーム開発で必要な要素をトレイニーに意識してもらいやすくする

やっていないこと

特になし

気になっていること

コメントとして記載しました

動作確認

PRテンプレートの仕組み自体はGitHubの機能なので、動作確認は割愛

f-yoshihara and others added 2 commits November 17, 2025 17:10
変更内容、実施内容、気になっていること、動作確認手順などの項目を含めたテンプレートを追加し、PRの品質向上とレビューの効率化を目指します。

🤖 Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
「やっていないこと(後でやりたいこと)」を「やっていないこと」に変更し、あえてやっていないことがあればその理由を記載するように促すメッセージに更新しました。

🤖 Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
@f-yoshihara
Copy link
Contributor Author

📝 「気になること」に他の Issue や PR との関連がある場合に、それを書いてもらうことを促すコメントを追加したい

@f-yoshihara
Copy link
Contributor Author

📝 「気になること」に他の Issue や PR との関連がある場合に、それを書いてもらうことを促すコメントを追加したい

気になっていること に追加するのは不自然に感じたので、その他の項目を設けてそこに上記のコメントを記載しました

@@ -0,0 +1,25 @@
## やったこと
<!-- 何がどう変わったのかを説明してください。必要に応じてスクリーンショットや動画も利用し、レビュワーが簡単に理解できるように工夫してください。 -->
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

レビュワーが簡単に理解できるように工夫してください

かと言って PR 作成に手間がかかりすぎないように(なるべく簡単にレビュー依頼できるように)誘導するコメントもあった方がいいかも?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

伝える側が努力したほうが伝わるコストは低くなるとは思いますが、そんな詳細に説明しなくていいよ〜ということもありますよね…
塩梅については万葉道場で学んでもらうとかでもいいのかもと思いました

@@ -0,0 +1,25 @@
## やったこと
<!-- 何がどう変わったのかを説明してください。必要に応じてスクリーンショットや動画も利用し、レビュワーが簡単に理解できるように工夫してください。 -->
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PRの変更によってユーザーにとってどんなメリットがあるか?も記載してもらっても良いかも?

@f-yoshihara f-yoshihara self-assigned this Dec 24, 2025
@f-yoshihara f-yoshihara marked this pull request as ready for review December 24, 2025 08:16
@f-yoshihara f-yoshihara requested review from akira888 and nay December 24, 2025 08:16
@f-yoshihara
Copy link
Contributor Author

2026/01/20 memo

  • 動作確認の実施状況を「動作確認手順」の配下から外して後ろに配置する
  • 前準備 & PR の変更内容の確認手順 の構成にする

@f-yoshihara
Copy link
Contributor Author

2026/01/20 memo

  • 動作確認の実施状況を「動作確認手順」の配下から外して後ろに配置する
  • 前準備 & PR の変更内容の確認手順 の構成にする

6a1fc89 で対応しました

@f-yoshihara f-yoshihara changed the title Add pr template GitHub の PR テンプレートを導入する Feb 18, 2026
Copy link
Contributor

@akira888 akira888 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

レビュワーとして欲しい項目は足りているかなと思いました!
1点だけコメントしています 🙏🏻

Co-authored-by: Akira Yagi <a.cup.of.happiness@gmail.com>
@f-yoshihara f-yoshihara requested a review from akira888 February 18, 2026 08:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants