連載
» 2014年07月28日 18時00分 UPDATE

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

ソフトウェア開発プロジェクトの共有Webサービス「GitHub(ギットハブ)」を「日本語で」分かりやすく説明するシリーズ、今回はコミュニケーションを図るための「issue(イシュー)」機能と「Markdown(マークダウン)」を解説します。

[Nextremer 下岡聡子,@IT]
本連載「海外Webサービスのトリセツ」のインデックス

連載目次

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

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

issueとは何か?

tori6_2.png issueページ

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

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

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

tori6_3.png 右上の「New issue(新規issue)」をクリックします。
tori6_4.png issue作成画面に遷移するので、issue名を入力します。担当者(assignee)が決まっている場合は歯車マークをクリックし、プルダウンリストからメンバーを選択します。
tori6_5.png 内容を入力し、「Submit new issue(新規issueを送信)」をクリックします。
tori6_6.png issueが作成されました!

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

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

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

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

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

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

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

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

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

tori6_9.png 「Markdown Basics(マークダウンの基礎)」ページ。
tori6_10.png

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



tori6_11.png

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


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


tori6_13.png

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


tori6_14.png 表示例


tori6_15.png

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


tori6_16.png 表示例


tori6_17.png

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


tori6_18.png 表示例


tori6_19.png

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


tori6_20.png 表示例


tori6_21.png

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


tori6_22.png 表示例


tori6_23.png

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


tori6_24.png 表示例


tori6_25.png

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


tori6_26.png 表示例


tori6_27.png

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


tori6_28.png 例えばこのように記述すると……
tori6_29.png 文字がリンクで表示されます。

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


tori6_30.png

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

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

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

「海外Webサービスのトリセツ」バックナンバー

筆者プロフィール

下岡聡子

Nextremer 下岡聡子

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

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


Copyright© 2017 ITmedia, Inc. All Rights Reserved.

TechTargetジャパン

この記事に関連するホワイトペーパー

RSSについて

アイティメディアIDについて

メールマガジン登録

@ITのメールマガジンは、 もちろん、すべて無料です。ぜひメールマガジンをご購読ください。