LoginSignup
27
28

More than 5 years have passed since last update.

「GitHub Issueはテンプレート化で、綺麗に書かせる!」を Emoji 厨が実践したら

Last updated at Posted at 2015-02-04

:musical_score: 概要

「GitHub Issueはテンプレート化で、綺麗に書かせる!」を :rage1: Emoji 厨 :rage1: が実践したら

経緯

下記エントリを受けてのエントリです。
GitHub Issueはテンプレート化で、綺麗に書かせる!

:musical_note: 実践

:raised_hand: 前提

:scroll: 仕様

  • ユースケースによってテンプレートを変更したい
    • 今回は bug, question の 2 ケースを例示します
      • ※そもそも Pull Request 時に Question というユースケースがないと思いますが説明の都合上ということで。

:bug: Bug 用の Template

## :mount_fuji: 背景
:exclamation: TODO: 経緯を書いてください。 :bow: 

## :warning: 問題点
:exclamation: TODO: 問題点を書いてください。 :bow: 

## :memo:  再現方法
:exclamation: TODO:再現方法(環境、手順)を書いてください。 :bow: 

## :mortar_board: 解決策 / 解決案
:exclamation: TODO: 解決策 / 解決案を書いてください。 :bow: 

:question: Question 用の Template

## :ear: 質問内容
:exclamation: TODO: 質問内容を書いてください。 :bow: 
## :ear: question
:exclamation: TODO: input your question :bow: 

Bug / Question 用の alias を設定

.gitconfig
[alias]
  bug = "!hub browse -- compare/master...$(git symbolic-ref --short HEAD)?body=%23%23%20%3Amount_fuji%3A%20%94w%8Ci%0D%0A%3Aexclamation%3A%20TODO%3A%20%8Co%88%DC%82%F0%8F%91%82%A2%82%C4%82%AD%82%BE%82%B3%82%A2%81B%20%3Abow%3A%20%0D%0A%0D%0A%23%23%20%3Awarning%3A%20%96%E2%91%E8%93_%0D%0A%3Aexclamation%3A%20TODO%3A%20%96%E2%91%E8%93_%82%F0%8F%91%82%A2%82%C4%82%AD%82%BE%82%B3%82%A2%81B%20%3Abow%3A%20%0D%0A%0D%0A%23%23%20%3Amemo%3A%20%20%8D%C4%8C%BB%95%FB%96%40%0D%0A%3Aexclamation%3A%20TODO%3A%8D%C4%8C%BB%95%FB%96%40%81i%8A%C2%8B%AB%81A%8E%E8%8F%87%81j%82%F0%8F%91%82%A2%82%C4%82%AD%82%BE%82%B3%82%A2%81B%20%3Abow%3A%20%0D%0A%0D%0A%23%23%20%3Amortar_board%3A%20%89%F0%8C%88%8D%F4%20%2F%20%89%F0%8C%88%88%C4%0D%0A%3Aexclamation%3A%20TODO%3A%20%89%F0%8C%88%8D%F4%20%2F%20%89%F0%8C%88%88%C4%82%F0%8F%91%82%A2%82%C4%82%AD%82%BE%82%B3%82%A2%81B%20%3Abow%3A%20%0D%0A"
  question = "!hub browse -- compare/master...$(git symbolic-ref --short HEAD)?body=%23%23%20%3Aear%3A%20%8E%BF%96%E2%93%E0%97e%0D%0A%3Aexclamation%3A%20TODO%3A%20%8E%BF%96%E2%93%E0%97e%82%F0%8F%91%82%A2%82%C4%82%AD%82%BE%82%B3%82%A2%81B%20%3Abow%3A%20"

動作確認

Bug Template

$ git bug
  • ブラウザで Pull Request ページが開くので Create Pull Request ボタンを押します
  • テンプレートが埋まった状態で Pull Request 作成ページが開きます

bug_report_write.png

bug_report_preview.png

Question Template

$ git question
  • ブラウザで Pull Request ページが開くので Create Pull Request ボタンを押します
  • テンプレートが埋まった状態で Pull Request 作成ページが開きます

question_write.png

question_preview.png

:pencil: 補足

見出しレベル

GitHub の Issue Title は H1 なので、
見出しレベル的に、 Issue コメントの中を構造化するなら
H2 からスタートするのが良いと判断しました。

:books: 外部資料

27
28
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
27
28