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

Pull Request テンプレートの導入 #15

Merged
merged 7 commits into from
Jan 5, 2025

Conversation

Meiryo7743
Copy link
Contributor

概要

Pull Request の文面の標準化や記入が捗るようにする目的で,テンプレートを導入します。

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

確認手順

  1. Pull Request を新規作成する
  2. ./.github/PULL_REQUEST/default.md の内容が入力欄に反映されているか確認する

Copy link
Member

@newt239 newt239 left a comment

Choose a reason for hiding this comment

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

このあたりは経験値が少ないのであくまで個人的な考えですが、テストのセクションは不要な気がしました
CIを導入する予定なのでテストが通らなければマージできないですし、追加したかどうかは差分を見れば分かると思うので

他のセクションはこれで良いと思います!

Copy link
Contributor

@saka-naname saka-naname left a comment

Choose a reason for hiding this comment

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

概要のセクションについて、目的は文章で、やったことは一覧として箇条書きで書いた方がセクションが長文にならずにスッキリ書けると思うので、概要に書く内容ごとにサブセクションを作って文章で書く場所と箇条書きで書く場所を分けるのが良いんじゃないかなと思います

@Meiryo7743
Copy link
Contributor Author

@newt239

確かに,テストに関する節は削除して良さそうですね……! その方向で修正します。


@saka-naname

Pull Request のテンプレートは ./.github/PULL_REQUEST/foo.md の如く複数の種類を任意に追加できます(cf., 先の公式ドキュメント)。

ひとまず本 PR で追加するテンプレートは,最も基本となる形のものとして merge する……という方針はどうでしょうか?


@MogamiTsuchikawa

上述を除くコメントがあればリプライをください🙇

特段のことが無さそうでしたら,修正後に再度 review と merge に進む予定です。

@saka-naname
Copy link
Contributor

Pull Request のテンプレートは ./.github/PULL_REQUEST/foo.md の如く複数の種類を任意に追加できます(cf., 先の公式ドキュメント)。

ひとまず本 PR で追加するテンプレートは,最も基本となる形のものとして merge する……という方針はどうでしょうか?

承知しました。いいと思います!

@MogamiTsuchikawa
Copy link
Member

@Meiryo7743

@MogamiTsuchikawa

上述を除くコメントがあればリプライをください🙇

個人的にはsakaくんの話したことと同じですが、箇条書き箇所の指定などをやっておくと良いと思います。(あと、UIの変更がある場合はスクショを強制させたいです)

Pull Request のテンプレートは ./.github/PULL_REQUEST/foo.md の如く複数の種類を任意に追加できます(cf., 先の公式ドキュメント)。

ひとまず本 PR で追加するテンプレートは,最も基本となる形のものとして merge する……という方針はどうでしょうか?

悩ましいところで、開発が進んで、他のメンバーが参加していったときに、PRドキュメントがおろそかになる文化が形成されそうで怖いです。
どちらかというと、デフォルトを型がかっちりとしたものにして、任意の別のテンプレートで緩いものを作る方がいいかなと思います。

Copy link
Member

@MogamiTsuchikawa MogamiTsuchikawa left a comment

Choose a reason for hiding this comment

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

LGTM

@Meiryo7743 Meiryo7743 merged commit 2f13fdb into main Jan 5, 2025
1 check failed
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.

4 participants