プルリクエストのテンプレートを作成する

[tsuna-can-se]

概要

現状プルリクエストのテンプレートが存在せず、コントリビュートに対する説明が不足するケースがある。
プルリクエストを説明するテンプレートを追加し、適切に説明が記載されるようにする。

このテンプレートは既定のプルリクエストテンプレートとして扱いたいため、「.github」フォルダーの直下に「pull_request_template.md」という名前で作成する。

詳細 / 機能詳細（オプション）

以下のようなテンプレートを計画。

## このプルリクエストで実施したこと

このプルリクエストで何をしたのか記載します。

## このプルリクエストでは実施していないこと

このプルリクエストと関連する機能やドキュメントに対して行わなかったことを記載します。
ない場合は「なし」で構いません。
既に Issue 等が整備できている場合は、リンクを記載します。

## Issue や Discussions 、関連する Web サイトなどへのリンク

関連する Issue や Discussion へのリンクを記載します。
また、このプルリクエストを作成するにあたり参照した資料へのリンクを記載します。

完了条件

• プルリクエストのテンプレートが追加されていること。
• GitHub.com 上でプルリクエストを作成したとき、テンプレートが利用されること。
• VS Code などの IDE からプルリクエストを作成したときも、テンプレートが利用されること（技術的に可能であれば）。

[rnakagawa16]

issue用のテンプレートについて、mdファイルとして正しい形式となっていないため警告が発生している。
「github の Issue や Pull Request のテンプレートを整備する」という Issue として対応することが可能か要相談。

[tsuna-can-se]

@rnakagawa16
警告の出ているものって対象はどのファイルですか？

[rnakagawa16]

@tsuna-can-se
.github/ISSUE_TEMPLATE に配置された以下の2ファイルです。

• general-issue.md
• openapi-generator-update-issue.md

レベル1のタイトルが複数ある旨の警告と、最終行が改行されていない旨の警告が発生しています。

[rnakagawa16]

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

上記内容を参考に、以下に記載の方法で対応する。

pull request テンプレートを複数作成し、template クエリ パラメーターを使用して
pull request の本文を埋めるテンプレートを指定するには、 .github/PULL_REQUEST_TEMPLATE/ と入力し、
続けてお使いの pull request テンプレートの名前を入力します。
 たとえば、「 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md 」のように入力します。 

[tsuna-can-se]

@rnakagawa16
なるほど、でしたらそれらは別のIssueとして対応しましょう。

[rnakagawa16]

@rnakagawa16 なるほど、でしたらそれらは別のIssueとして対応しましょう。

承知しました。
Issue として別途作成いたします。

[rnakagawa16]

main にマージした現時点での環境でわかったこと

textlint のコメントは無視されること

設定のtextlint のコメントごと出力されるが、実際にgithub上で表示される部分にはコメント部分は除外して出力される。

VSCode と ブラウザでの動作の違い

VSCode上ではマージリクエストの本文にテンプレートが反映されるが、ブラウザ上では反映されない。

[rnakagawa16]

Pull request のテンプレートが一つの場合

https://stackoverflow.com/questions/52139192/github-pull-requests-template-not-showing

上記のURLのように、Pull request のテンプレートが一つの場合、サブフォルダーに格納してもうまく動かない可能性がある。
将来のことを考えて複数のテンプレートを作成しておくか、現時点では一つのテンプレートなのでサブフォルダーを作成しないかを考える。

[rnakagawa16]

Pull request テンプレート作成時の警告への対処方法について

Pull request テンプレートで発生する警告について

markdownlint

カスタムルール：（titleとdescriptionが必須のメッセージ）が存在しない場合のメッセージ
MD041：h1レベル（#）の項目が存在しない場合のメッセージ

CMD001/requires-title-and-description: All documents should specify title and description [Title is not specified]markdownlint(CMD001)
MD041/first-line-heading/first-line-h1: First line in a file should be a top-level headingmarkdownlint[MD041](https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md041.md)

textlint

require-header-id：各項目にidが付与されていない場合のメッセージ

Header should have id that match /{#[a-zA-Z\d.-]+}$/ (@textlint-rule/require-header-id)textlint(@textlint-rule/require-header-id)

対処法

markdownlint

• .markdownlintignore を利用する

　　　.markdownlintignore に除外するファイルを設定したところ、CLIによるチェックでは正しく除外した上でlintが実行されたが、
　　　VSCode の GUI 上では依然警告が発生したままであった。

• markdownlint-cli2 を利用する
  　　　
  　　　markdownlint-cli2のglob設定を利用する。
  　　　上記の設定のために、markdownlint-cliからmarkdownlint-cli2に移行する。
  　　　この設定を実行することで、VSCode上においてもmarkdownlintの警告がなくなり、正常に除外処理が実行されていることを確認した。

textlint

本来であれば、.textlintignore の設定がVSCode上でも反映されるはずであるが、以下のように正しく反映されない旨を修正するPull requestが発行されている。
taichi/vscode-textlint#72
こちらがマージされることで上記の警告も解除されるはず。

[tsuna-can-se]

#1432 にてmarkdownlintの設定変更を実施