search

Qithub-BOT / Qithub-ORG

✅ Qithub サークルのメインリポジトリ。運用／ルール／全リポジトリの Issue など取りまとめています。
https://Qithub.tk/
Creative Commons Attribution Share Alike 4.0 International
10 stars 2 forks source link

【提案】Issue のテンプレート設置 #163

Open KEINOS opened 6 years ago

KEINOS commented 6 years ago

提案

  1. リポジトリごとの Issue テンプレートを Qithub-ORG のリポジトリに用意したい。
  2. (OR) 新規 Issue 作成のリンクを用意したい。

詳細

リポジトリに、テンプレートのディレクトリとファイルを設置すると、Issue の新規作成リンクのクエリ引数でテンプレートが指定できるそうです。

https://github.com/Qithub-BOT/Qithub-ORG/issues/new?template=issue_QiiCipher.tpl.md

また、テンプレートの指定以外にタイトルなどもクエリに含められるそうです。

https://github.com/Qithub-BOT/Qithub-ORG/issues/new?labels=bug&title=New+bug+report

各リポジトリの README に「Issue は Qithub-ORG へ」と Issue の挙げ先をここに統一していますが、今後、どのリポジトリの案件なのか把握しづらくなると予測されます。

ラベルを貼るにしてはラベル・チームの負担が大きく、面倒なので、テンプレートを設置するか、リンク（タイトルや本文を含めたクエリ付きのリンク）のテンプレートを用意した方がいいかなと感じています。

TL;DR（進捗・結論 2018/10/13 現在）

KEINOS commented 6 years ago

本件ですが、Issue の本文自体は共通で使えると思われ、どのリポジトリ案件かがわかることが重要なので、少なくともタイトルで概要（リポジトリ）がわかれば十分だと思われます。

そのため、Issue のテンプレート作成よりは、リンクにタイトルを含めるクエリ方式で進めていった方が楽でシンプルでいい気がしてきました。

試しに QiiCipher リポジトリの README でタイトル付き Issue 新規作成リンクを作ってみますので、その PR で良い感じだったら本 Issue クローズしましょう。

Close 後は、Wiki のリポジトリルール にページを作成して、そこに追記していく感じでいかがでしょう？ （Wiki も使いやすいように整理 CentOS）

hidao80 commented 6 years ago

まだCloseしていないようなので…

対案A

Issueテンプレートの先頭（h1レベル）にリポジトリ名とその略記号を書いておき、リポジトリ略記号をIssueの件名の先頭に記入するように案内する。

例

ISSUE_TEMPLATE.md

# 対象リポジトリ略記号を件名にの先頭に記入してください！

【】内は略記号

  • Qithub-ORG【ORG: 】
  • QiiCipher【CIP: 】
  • Qiita-SPAMS【SPA: 】
  • Qithub-DEV【DEV: 】
  • Qithub-CMD【CMD: 】
  • Qithub-CORE【COR: 】
  • Qiita-items【ITE: 】
  • ChQiita【CHQ: 】

Issueのタイトル

CIP: 【訂正】ドキュメントの言語指定から地域コードを削除

って感じでどうでしょ？

いちいち消さないとIssueの先頭に毎回リポジトリ名リストが付いてくるのが弱点ですが、リンクを踏まなかったという、一般的なGitHubの作法に則ったIssueが厄介者扱いされるよりは、Issueを書くたびにアラートが出るほうが親切だと考えます。
契約主義的すぎますかね？

KEINOS commented 6 years ago

まだCloseしていないようなので… @hidao80

すんまそん。単純に Wiki の作成がおざなりになってるだけでやんす。 🙇

ただ、リンクを踏まずに既存 Issue を覗いてから Issue を立てようという本筋のフローを考えると、確かに微妙でありんす。

契約主義的すぎますかね？

リポジトリ名の ID 化は個人的に好みです。ただ、契約主義的すぎというより、アチキのリンクに埋め込む系の案も含めて KISS が必要と思われます。

すでに、現在の Issue のテンプレも情報量が多く、これ以上増えると何をテンプレから削除していいのかもわからなくなってくると思います。

ブレストA（複数テンプレの活用）

PHP の BOX という、他 Organization のリポジトリなのですが、新規 Issue を作成するとレポートする内容のテンプレが選択できます。

これを Qithub-ORG のリポジトリに応用できないでしょうか。例えば、カテゴリ別でなくリポジトリ名ごとに設けるとか。

new issue humbug box

ただ、この場合「Get Started」ボタンを押しても、本文にリポジトリ名は挿入できても、タイトルには挿入できないという問題があります。（方法があるのかしら？）

「Issue を開かないと、どのリポジトリ案件かわからない」というのが最も避けたい事態なので、やはり対案 A のようにテンプレに「タイトルに記載してね」とユーザーに期待するしかないのですが、うーむ。

なーんか、もっとシンプルに解決できる方法がある気がするのでございます。

hidao80 commented 6 years ago

PHPのBOXリポジトリの例、見てみました。

すごいですね！　よさげな仕組みだと思います。👍

これの応用でラベルを自動でつけることができないでしょうか？　もし可能ならば、ラベルでリポジトリを判別することができると考えます。

こちらでも調査してみますね。

hidao80 commented 6 years ago

ラベル無理でした...orz

しかし、このIssue template機能と対案Aの合わせ技で、各リポジトリ用のテンプレート先頭に略記号を一つだけ書いて「タイトルにコピペしてね！」とは言えそうです。

ブレストB

tempsnip

KEINOS commented 6 years ago

やはり、テンプレ内でお願いするしかないですよねぇ。とりあえず、以下の方向ですかな。

  1. リポジトリ毎にテンプレを用意する
  2. リポジトリの ID （短縮名）を決定する
  3. テンプレにてタイトルへコピペ依頼を記載する

How to issue 的な Wiki を用意すればテンプレももう少し簡素化でるとは思うのですが、まぁ、ぼちぼちやって行きましょう。

hidao80 commented 6 years ago

👍

その線で行きましょう！

hidao80 commented 5 years ago

なんかいまIssues template見てたら、デフォルトタイトルとデフォルトラベルが指定できるようになってました！

これ使えばこのスレッドの問題、オールクリアな気がしてきました。念のため、Issues template作成画面のスクリーンショットを添付しておきます。（注記がフリーハンドのため汚くて申し訳ない！）

Settingsからしか用意できないみたいなので、@KEINOS さんにお任せになってしまいますが…

inked _li