Pull Request Template を導入する

[m-tmatma]

PR の目的

Pull Request Template を導入することによって、必要な情報が PR 作成時点で集まるようにする。

カテゴリ

• 機能追加
• その他 (GitHub 関連)

PR の背景

Pull Request の形式がバラバラで必要な情報がない、あるいは書かないことがあるので
書く内容の指針を作る。

PR のメリット

必要な情報がないことで、複数回やり取りが発生して、なかなか、PR がマージされない
ような事態を軽減できる。

PR のデメリット (トレードオフとかあれば)

必要な情報を記載するのがめんどくさい。

PR の影響範囲

Pull Request を投げるときの説明欄に初期値が入る。

関連チケット

#69

参考資料

Pull Request 関連

• https://note.mu/koushikagawa/n/nd517d9f09c3a
• https://help.github.com/en/articles/creating-a-pull-request-template-for-your-repository
• https://stackoverflow.com/questions/52139192/github-pull-requests-template-not-showing

キーワード関連

• https://help.github.com/en/articles/closing-issues-using-keywords
• https://stackoverflow.com/questions/1687262/link-to-the-issue-number-on-github-within-a-commit-message
• https://github.blog/2013-01-22-closing-issues-via-commit-messages/

[m-tmatma]

この PR の説明欄は https://github.com/sakura-editor/sandbox の master にこの PR のテンプレートを
入れたうえで sakura-editor/sandbox#24 で PR を作成してテンプレートが動いたものをコピーして、調整したものになります。

[m-tmatma]

カテゴリの部分を少し追加しました。

[takke]

そういえば、、「カテゴリー」って「ラベル」を付けるので代用できないですかね？
選択した上で該当するラベルを忘れずに付けるという運用でもいい気もしますけど、PRのテンプレートって一般的にどうなのかなーと思いました。

[m-tmatma]

本文に書くと見やすいし、開発グループ外の人も自由に足したりできるのかな？と思います。
でもチェックボックスが、タスクリストのように認識されてしまうのが、問題です

[takke]

モバイルのブラウザで見るとリードオンリーのチェックボックスなので何か魔法を使ってるのかと思いましたがPCのブラウザだとただのチェックボックスなんですね（PCだとチェックで即時に編集できるので）

なので本当のタスクリストを本文に設けようとしたときに問題になる（具体的には進捗表示が正しい数値にならない）気がします。

別の書き方にするか（ただの - のリストがテンプレートにあり、そこから該当カテゴリーだけ残す、のような）、
カテゴリーはラベルを代用するか、
が個人的には好みっすね。

[berryzplus]

全部見れてなくて、思いっきり主観なんですけど・・・

なので本当のタスクリストを本文に設けようとしたときに問題になる（具体的には進捗表示が正しい数値にならない）気がします。

タスクリスト本来の用途と違う使い方に対する疑問はぼくも感じていました。
本当にタスクリストを使いたい場合にバッティングしますね。

代案なし、すまぬ・・・。

[m-tmatma]

#921 マージ後に、Azure Pipelines の再ビルドをかける予定。

[m-tmatma]

コメント扱いにして、関係するものだけ有効化するてもあります

[m-tmatma]

コメント扱いにして、関係するものだけ有効化するてもあります

やってみたら運用しにくそうだったので、

別の書き方にするか（ただの - のリストがテンプレートにあり、そこから該当カテゴリーだけ残す、のような）、

こちらで対応しました。

[m-tmatma]

説明欄の PR の目的 のところを修正。
目的 ではなく、やること を説明しているだけだったので修正

[takke]

ありがとうございます。
イメージ通りです！

[m-tmatma]

ありがとうございます。
イメージ通りです！

approve いただきましたが、少し記述を追加しました。

[m-tmatma]

#911 で #911 (comment), #911 (comment), #911 (comment) でのことを念頭にコメントに追加しました。

[m-tmatma]

たぶんこれで最後