Skip to content

Instantly share code, notes, and snippets.

Show Gist options
  • Select an option

  • Save Hiroshiba/20d1a5b99f04014d0656f554180a8083 to your computer and use it in GitHub Desktop.

Select an option

Save Hiroshiba/20d1a5b99f04014d0656f554180a8083 to your computer and use it in GitHub Desktop.
PRテンプレート・Issueテンプレートの改善と整理 のissue案.md

内容

PRテンプレートとIssueテンプレートを改善したいです。 ついでに各リポジトリに重複しているテンプレートの整理と、questionラベルの統一もやりたいです。

やりたいこと

  1. PRテンプレート・Feature Requestテンプレートに「何を解決したいのか」を追記する
    • 判断のためにWhyがほしいんだけど、「理由を書いて」だと人によって異なるから、「何を解決したいか書いて」と案内したい
  2. 各リポジトリの重複テンプレートを削除して .github リポジトリのテンプレを使う
    • 一部リポジトリを除いて、同じ内容のテンプレートが複数リポジトリにコピーされている状態なので
  3. Questionテンプレでissue作ったときに付くラベルを整理したい
    • question要議論ラベルのうち存在する方がラベル付くようにすれば、.githubのテンプレを使い回せるはず

テンプレートの変更内容

変更後のPRテンプレート案↓。最初のとこ以外は特に変えないで良いかなと。

<!--
このプルリクエストで何を解決したいのかと、内容説明を端的に記載してください。
-->

Feature Requestテンプレート(変更後):

<!-- ここに要望する機能を記載してください -->
<!-- その機能で何を解決したいのか、具体例も -->
調査結果: 各リポジトリのテンプレート状況
リポジトリ PR テンプレート ISSUE_TEMPLATE
.github(共有) あり bugreport / featurerequest / question
voicevox あり(.githubと同一) あり(.githubと実質同一)
voicevox_engine あり(.githubと同一) あり(questionラベルが 要議論
voicevox_core あり(スクショ欄なし) あり(OS選択肢にAndroid/iOS追加、questionラベルが 要議論
onnxruntime-builder なし あり(voicevox_coreと同一)
voicevox_resource なし あり(voicevox_engineと同一)
voicevox_telemetry_gas あり(.githubと同一) あり(もう使っていないリポジトリ)

GitHub の仕様として、リポジトリに .github/ISSUE_TEMPLATE/ ディレクトリがある場合はそれだけが使われ、ない場合に .github リポジトリにフォールバックします。PRテンプレートは個別にフォールバックします。

リポジトリ別の作業内容

voicevox_core と onnxruntime-builder は OS 選択肢に Android/iOS が含まれているため、ISSUE_TEMPLATE は引き続き個別に持つ。

リポジトリ 作業内容
.github PRテンプレート変更 + featurerequest変更 + questionラベル変更
voicevox PRテンプレート削除 + ISSUE_TEMPLATE全削除
voicevox_engine PRテンプレート削除 + ISSUE_TEMPLATE全削除
voicevox_core PRテンプレート変更 + featurerequest変更 + questionラベル変更
onnxruntime-builder featurerequest変更 + questionラベル変更
voicevox_resource ISSUE_TEMPLATE全削除
voicevox_telemetry_gas PRテンプレート削除 + ISSUE_TEMPLATE全削除

マージ順序: .github リポジトリの変更を先にマージしてから、他リポジトリの削除PRをマージする必要があります。

その他

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment