Edited at

知って「おっ!」てなったGitHubの知識7選

More than 3 years have passed since last update.

GitHubダイスキー!

ということで、知った時に「おっ!」と感じたGitHubに関する事項を選出してみました。

あなたに「おっ!」と思ってもらえたら幸せです。

Octocat.png


1.入れておくと、意味を持つファイル名がある。


README.md

README.mdは有名ですよね。リポジトリのトップにREADME.mdという名称でマークダウンを入れておくと、GitHubで解釈されて表示されます。

それ以外にも、あるのです。意味のあるファイル。


ISSUE_TEMPLATE.md

トップか、.github/というフォルダにISSUE_TEMPLATE.mdという名のファイルを入れると、GitHubでIssueを作った時にこのファイルの内容が入ります。書くべき項目を羅列しておくとルール化できていいですよね。

それ以外にも


PULL_REQUEST_TEMPLATE.md

を入れておくと、Pull requestを作った時のデフォルト値になります。


CONTRIBUTING.md

を入れておくと、Pull RequestやIssueを作るときに、「ちゃんとコレ見てからやりなさいよ」的なリンクを表示してくれます。

スクリーンショット 2016-02-25 12.46.29.png

こんなふうに。

ファイルの詳細はこちらで説明されてます。


2.コメント入れておくと、Issueを自動でクローズしてくれる。

決まった表記方法でコミットにコメントを入れておくと、Issueを自動でクローズしてくれます。

私の好きな書き方は 

Fixes #1

ですが、書き方はいろいろあります。


3.github.com上でタグ切れて、リリースできる。

タグにひも付けてバイナリファイルをアップロードすることができます。

コンパイル後や、パッケージ化されたアプリケーションをリリースするのにいいですね。

私はElectronでパッケージ化したファイルをリリースにひも付けてます。こんな感じです。


4.意味のあるリポジトリ名文化。

GitHubではアカウント毎にリポジトリを作成できます。このページをみて、tilは知ったのですが、リポジトリ名をコモンセンス化するのが流行ってます。私が知っているのは til、Today I Learnedと、設定系ファイルを保持する、dotfilesです。他にあれば、教えてください。共通知識が出来ると幸せです。


5.hubコマンド

GitHubはその名の通りGitのリポジトリサービスで、Gitコマンドがあれば操作できるのですが、GitHub社お手製の「hubコマンド」を使うともっと便利にGitHubを操作することができます。

hubコマンドが持っている機能は例えば、

hub create 今いるリポジトリのディレクトリ名と同名のリポジトリをGitHub上に作成することができます。

hub pull-request プルリクエストを作成できます。

です。

gitにAliasを切って、gitコマンドの代わりにhubコマンドを使うことも出来ます

また、GitHubにはデスクトップアプリもあるので、GUI好きの方は使ってみてはいかがでしょうか?


6.レビューコメントやPull request、Issueにチェックボックスを作れる。

- [ ] todo it.

のような形式でレビューコメント、Rull request、Issueに書いておくと、編集可能なチェックボックスを作ることができます。

こんな感じです。

スクリーンショット 2016-02-29 12.52.54.png

例えば、レビューの指摘が複数あった時に、備忘録としてタスクをチェックボックスに並べ、タスクを終えたらチェックしていく、という使い方もできますね。


7.静的Webページを公開できる。

「ユーザ名.github.io」という名前のリポジトリを作成すると、そのURLでアクセスできるWebページを作成してくれます。その名もGitHub Pages

Organizationを作成して、「Organization名.github.io」というリポジトリ名でも作成できるので、ページはいくつでも作成できます。

また、DNSでC Nameレコードを切って独自URLで運営もできます。

構成管理されたWebページを持てるのは魅力的です。


いかがでしたでしょうか?あなたの「おっ!」があれば幸いです。


この記事は週刊クラウドの一投稿として作成されています。