ソフトウェア開発プロジェクトの共有Webサービス「GitHub(ギットハブ)」を「日本語で」分かりやすく説明するシリーズ、今回はコミュニケーションを図るための「issue(イシュー)」機能と「Markdown(マークダウン)」を解説します。
チームでのソフトウェア開発に便利な「GitHub(ギットハブ)」のトリセツ、今回はコミュニケーションを図るための「issue(イシュー)」機能を解説します。
issueとは「重要事項、(提起された)問題」という意味で、開発メンバー間で共有が必要な事項をスレッド形式で立てられる機能です。
同じリポジトリに属するメンバーなら誰でもissueの作成、コメント、削除などの操作を行えます。issueが更新されるたびに登録したメールアドレスに連絡が届くため、見逃しも少ない(はず)です。
早速、新しいissueを作成してみましょう。
issueの内容は「この機能を追加しました! ご意見ください」「問題発生、助けてください」「この作業お願いします」など多岐にわたります。
コメント欄に「@」と打ち込むと、メンバーのユーザー名リストが表示され、特定のメンバーにメッセージを送ることができます。複数人でissue内容を共有しており、そのうちの誰かに特に見てほしい場合に便利です。
新規作成したissueは、「Open(開示)」状態になっています。依頼した作業が終了したり問題が解決したりした場合は、「Close(終了)」できます。
issueは連番式で、削除ができません。削除とほぼ同じ働きをするのがCloseだと考えてください(筆者が安易に作成してしまったテストイシューは、哀れにもClose boxに格納されました)。
ここからはissueを見やすくするための記述法について解説します。知っておくと一味違う投稿ができますよ!
issueでは「Markdown(マークダウン)」という、文章記述用のマークアップ言語を使用します。GitHubのヘルプで、マークダウン記述についての説明を閲覧できます。以下で、各項目を簡単に紹介しましょう。
見出し 文の最初に「#」を付けます。HTMLの見出しタグと同じです。
リンク URLをそのまま記載するだけでリンクが張られますが、特定の文字にリンクを付けたい場合は、文字を「[]」で囲み、その後ろに「()で囲ったリンク」を記述します。
いかがでしたか? 今回は記述の基礎をご紹介しましたが、他にもヘルプページで詳細が紹介されています。
上記で紹介したページは、いずれもGitHubのヘルプ画面で検索、閲覧できます。英語での検索なので少々困難に感じるかもしれませんが、キーワードを知っていると便利です。例えば今回の「markdown」で検索すると、上記のページを含む検索結果が表示されます。
issueを活用して、GitHubでの円滑なコミュニケーションを図ってください。
次回(7月31日)は、GitHubと連携して使用できるさまざまなサービスを紹介します。
Nextremer 下岡聡子
Javaプログラマー、フリー翻訳者(英語・中国語)を経て、Nextremerにてインドでのグローバル受託開発システムのマネジメント、新規ビジネス企画担当。大学ではロシア語を専攻。
ITエンジニア向けの英語サービスも提供中。
Copyright © ITmedia, Inc. All Rights Reserved.