僕は僕でだれかじゃない

ビジネスとテクノロジーと健康についてあれこれ

MENU

【初心者向け】コーディングガイドラインをGitHubで管理する覚え書き

先日、WordCamp Kansaiの下記セッションに参加してきました。

www.kobatatakayuki.com

他の人は、ガイドラインをどのように管理しているのだろうか。

WordCamp Kansaiに参加して、GitHubは、ソースコードの管理だけでなく、ドキュメントの管理にも向いてるのね。ということを知りました。

その時の復習と応用ということで。

コーディングガイドラインをGitHubに移行してみました。

内容が整えば公開しても良いかなと思ってますが、、、

どうなるやら。

GitHubの使い方で間違いや認識違いがありましたら、ご指導いただければ幸いです。

これで、GitHub 脱初心者!

Git と GitHubについて

まずは、認識を間違えないように。

Git

  • 「ギット」と読む
  • ドキュメントやソースコードなどの変更履歴を管理する「分散型」のバージョン管理システム

GitHub

  • 「ギットハブ」と読む
  • Gitの仕組みを利用して、ドキュメントやソースコードなどを保存、公開することができるようにしたウェブサービスの名称

プロジェクトをフォークする

f:id:sitk:20160713133232p:plain

リポジトリからクローンする

フォークすると、こんな画面になります。

f:id:sitk:20160713133244p:plain

f:id:sitk:20160713133253p:plain

クローン用のリポジトリは、HTTPS形式でお願いします。

レビュー開始

レビューして、修正した方が良いんじゃないか!というのがあれば、修正します。

その後、コミット&プッシュ!

プルリクエスト

あらかた修正や、気になる箇所の対応が完了したら、プルリクエストをします。

手順はこちら。

f:id:sitk:20160713133236p:plain

f:id:sitk:20160713133239p:plain

これが、GitHubの醍醐味!

プルリクエストとは簡単に言うと、開発者のローカルリポジトリでの変更を他の開発者に通知する機能です。

www.backlog.jp

ここで、管理者がNGやOKを出していきます。

そうすれば、本流にがっちゃんこされるわけです。

ここでコミュニケーションを図りながら、対応していきます。

うまくいかない時は、ググッてくださいw

フェッチ

これが、ちょっとややこしかった。

更新が進むと、自分のローカルと本流で差分がでてきます。

そのときには、フェッチでマージしていきます。

リポジトリ設定を行う

「リポジトリ」→「リポジトリ設定」を選択します。

f:id:sitk:20160713133314p:plain

「リモートの名前」を記載します。(upstreamと付けるのが慣例とのこと) その後、「URL/パス」に、フォーク元のリポジトリ名を記載します。

f:id:sitk:20160713133307p:plain

f:id:sitk:20160713133303p:plain

フェッチする

f:id:sitk:20160713133330p:plain

f:id:sitk:20160713133347p:plain

f:id:sitk:20160713133403p:plain

OKを押すと、本流からデータがマージされます。

issues(イシュー)

https://github.com/kobatatakayuki/guideline/issues

掲示板みたいな使い方ですね。

議題があれば、こちらで議論します。

wiki

wikiですね!

さいごに

GitHubは、ドキュメントを管理するにも向いてますね。

使い方を覚えたら、これは辞められない。

これも読んでみよう。

GitHub実践入門 ~Pull Requestによる開発の変革 (WEB+DB PRESS plus)

GitHub実践入門 ~Pull Requestによる開発の変革 (WEB+DB PRESS plus)

おわり。