GitHub（ギットハブ）の使い方：issue（イシュー）編：海外Webサービスのトリセツ（6）

連載目次

　チームでのソフトウェア開発に便利な「GitHub（ギットハブ）」のトリセツ、今回はコミュニケーションを図るための「issue（イシュー）」機能を解説します。

サインインしてリポジトリページに飛ぶと、右側のバーに「issues」が見えます（クリックすると大きな画像を表示します）。

issueとは何か？

issueページ

　issueとは「重要事項、（提起された）問題」という意味で、開発メンバー間で共有が必要な事項をスレッド形式で立てられる機能です。

　同じリポジトリに属するメンバーなら誰でもissueの作成、コメント、削除などの操作を行えます。issueが更新されるたびに登録したメールアドレスに連絡が届くため、見逃しも少ない（はず）です。

　早速、新しいissueを作成してみましょう。

右上の「New issue（新規issue）」をクリックします。

issue作成画面に遷移するので、issue名を入力します。担当者（assignee）が決まっている場合は歯車マークをクリックし、プルダウンリストからメンバーを選択します。

内容を入力し、「Submit new issue（新規issueを送信）」をクリックします。

issueが作成されました！

　issueの内容は「この機能を追加しました！ ご意見ください」「問題発生、助けてください」「この作業お願いします」など多岐にわたります。

　コメント欄に「＠」と打ち込むと、メンバーのユーザー名リストが表示され、特定のメンバーにメッセージを送ることができます。複数人でissue内容を共有しており、そのうちの誰かに特に見てほしい場合に便利です。

青色の部分をクリックして、ユーザー名を選択します。

　新規作成したissueは、「Open（開示）」状態になっています。依頼した作業が終了したり問題が解決したりした場合は、「Close（終了）」できます。

コメント欄下の「Close issue」をクリックします。

　issueは連番式で、削除ができません。削除とほぼ同じ働きをするのがCloseだと考えてください（筆者が安易に作成してしまったテストイシューは、哀れにもClose boxに格納されました）。

issueの書き方をマスターする

　ここからはissueを見やすくするための記述法について解説します。知っておくと一味違う投稿ができますよ！

　issueでは「Markdown（マークダウン）」という、文章記述用のマークアップ言語を使用します。GitHubのヘルプで、マークダウン記述についての説明を閲覧できます。以下で、各項目を簡単に紹介しましょう。

「Markdown Basics（マークダウンの基礎）」ページ。

　段落　段落変えは、文の後ろに空行を挿入するだけです。

　見出し　文の最初に「#」を付けます。HTMLの見出しタグと同じです。

見出しの機能を使うと、このような感じに表示されます。上段が「#」1つの場合。「#」の数を増やすと、下段のように小見出しになります。

　引用　引用箇所の最初に「>」を挿入します。

表示例

　書体　文を「* *」で囲むと「イタリック体」、「** **」で囲むと「太字」になります。「*」の代わりに「_（アンダーバー）」も使用できます。

表示例

　番号なしリスト　先頭に「*」、もしくは「_（アンダーバー）」を付けるとリストが表示されます。

表示例

　番号付きリスト　（そのままですが）先頭に番号を付与します。

表示例

　入れ子リスト　「*」を先頭に付与、その下のリストは「ダブルスペース＋ *」で入れ子のリストが出来ます。

表示例

　インライン記述　ソースコードや用語などを記述する際に使います。テキストを「バックティック（ ` ）」で囲むと下のように表示されます。

表示例

　複数ライン　ソースコードを複数行引用したい場合は、「```」で対象の行を挟みます。

表示例

　リンク　URLをそのまま記載するだけでリンクが張られますが、特定の文字にリンクを付けたい場合は、文字を「[]」で囲み、その後ろに「()で囲ったリンク」を記述します。

例えばこのように記述すると……

文字がリンクで表示されます。

　いかがでしたか？ 今回は記述の基礎をご紹介しましたが、他にもヘルプページで詳細が紹介されています。

　上記で紹介したページは、いずれもGitHubのヘルプ画面で検索、閲覧できます。英語での検索なので少々困難に感じるかもしれませんが、キーワードを知っていると便利です。例えば今回の「markdown」で検索すると、上記のページを含む検索結果が表示されます。

　issueを活用して、GitHubでの円滑なコミュニケーションを図ってください。

　次回（7月31日）は、GitHubと連携して使用できるさまざまなサービスを紹介します。

筆者プロフィール

Nextremer　下岡聡子

Javaプログラマー、フリー翻訳者（英語・中国語）を経て、Nextremerにてインドでのグローバル受託開発システムのマネジメント、新規ビジネス企画担当。大学ではロシア語を専攻。

ITエンジニア向けの英語サービスも提供中。