Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PullReq作成時にテンプレートが反映されるように修正 #5834

Merged
merged 3 commits into from
Nov 25, 2022

Conversation

ksmxxxxxx
Copy link
Contributor

Issue

概要

  • 公式のプルリクエストテンプレートの追加.github/PULL_REQUEST_TEMPLATE/pull_request_template.mdを作成すれば、適用されるとのこと。
  • しかし確認してみたところ3年前に追加されているものの、PullReq作成時に適用されることはなく、そのせいで使われることもなかった(ように見受けられた)
  • bootcampのリポジトリでいろいろ試してみるのはしのびなかったので、手前のアカウントで以下のことを試して検証してみる
    1. 公式のガイドにかかれているとおりのディレクトリ構造で、PullReq作成時にテンプレが適用されるか確認してみる
    2. 適用されないことを確認。ディレクトリを変更したら適用されるようになるのかを試してみる
      • .github/PULL_REQUEST_TEMPLATE/{任意のファイル名}.md で適用されるようになるのか?→されなかった
      • .github/PULL_REQUEST_TEMPLATE.mdで適用されるのか?→適用された
      • .github/pull_request_template.md(ファイル名小文字)で適用されるのか→適用された
      • 上記の作業は Discord分報で詳細をみることができます
  • 以上の確認作業から、以下の作業を実施
    • mv .github/PULL_REQUEST_TEMPLATE/pull_request_template.md .github/pull_request_template.mdを移動
    • rm -rf .github/PULL_REQUEST_TEMPLATEで不要になったディレクトリを削除
    • テンプレート内容を、直近の受講生さんのPRを参考に変更

変更確認方法

  1. 今回の変更はmainブランチにマージされないと確認することできません。

レビューほしいところ

テンプレート内容で「こういう項目もあったほうがいい」とか、「この項目はあまり使わないのでなくても大丈夫」などあればコメントください

@ksmxxxxxx ksmxxxxxx linked an issue Nov 24, 2022 that may be closed by this pull request
@ksmxxxxxx ksmxxxxxx marked this pull request as ready for review November 24, 2022 05:22
@ksmxxxxxx
Copy link
Contributor Author

@sadanora おつかれさまですー

PullReqを作成しましたので、レビューをお願いしたいです! 🙏🏻
よろしくおねがいします〜

@ksmxxxxxx ksmxxxxxx self-assigned this Nov 24, 2022
@sadanora
Copy link
Contributor

@ksmxxxxxx
レビュー依頼ありがとうございます!

テンプレート内容で「こういう項目もあったほうがいい」とか、「この項目はあまり使わないのでなくても大丈夫」などあればコメントください

私なりに思ったことを書いてみました〜

なお、最近チーム開発に入ったばかりで、私はPR作成の際はいつもGood First Issue 攻略・その1「着手からレビュー依頼まで」Pull Requestを作成する | FBCを参考にしています。
あまり多くのパターンを知らないので、参考URLの記入例に「寄せる」感じの意見になってしまっていると思いますがその点はご容赦ください:pray:

変更確認方法

ブランチの取り込みと、ブートキャンプアプリの起動までは記入例に含めてもいいのかなと思いました。(多くのPRでほぼ行いそうなので)

1. ブランチ`feature/<ブランチ名>`をローカルに取り込む
2. `bin/rails s`でローカル環境を立ち上げる
3. ...

screenshot

テーブル見やすくて良いと思うのですが、テーブルを使っているPRは少なくとも私はほとんどみたことがなく、以下の方がいつも通り使ってもらえやすそうだなと思いました〜

## 変更前

<img ...>

## 変更後

<img ...>

@ksmxxxxxx ksmxxxxxx force-pushed the feature/add_pull_request_template branch from b1dee07 to bc33e1b Compare November 25, 2022 08:28
@ksmxxxxxx
Copy link
Contributor Author

@sadanora レビューありがとうございます!

bc33e1b

☝🏻 こちらで修正させてもらいました。

Screenshotについては、レビューどおりに修正させてもらったんですが、変更内容確認方法については、ローカルに対象のブランチをチェックアウトするところは同じだと思うんですが、変更内容によっては、rails serverする前にrails db:migrateする必要があったりするものもあったりするので「そこまで書かなくてもいいかなぁ」と思ったので追加していません。

お手数かけますが、再度ご確認いただけると〜 🙏🏻

Copy link
Contributor

@sadanora sadanora left a comment

Choose a reason for hiding this comment

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

@ksmxxxxxx
ご確認&修正ありがとうございます〜!
問題ないと思うのでApproveさせていただきました!

@ksmxxxxxx
Copy link
Contributor Author

@sadanora レビュー && Approvedありがとうございます!

@komagata お疲れさまです。メンバーレビューがすみましたので、レビューお願いいたします 🙇🏻‍♀️

Copy link
Member

@komagata komagata left a comment

Choose a reason for hiding this comment

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

確認させて頂きました。OKです〜🙆‍♂️

@komagata komagata merged commit 4ad187e into main Nov 25, 2022
@komagata komagata deleted the feature/add_pull_request_template branch November 25, 2022 17:17
@github-actions github-actions bot mentioned this pull request Nov 25, 2022
18 tasks
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.

Pull Request作成用のテンプレートがほしい
3 participants