Git/GitHub
- Yoshiro Nishimura
- Takuya Futatsugi [nikkie にっきー] (Unlicensed)
PyCon JPではこのマニュアルや開発しているソースコードのバージョン管理に GitHub を使用しています。 普段、開発などを行わない人向けに、基本的な使い方を書きます。
PyCon JP では PyCon JP という Organization でコードを管理しています。この Organization は PyCon JP スタッフは誰でもリポジトリの追加、書き込みが可能です。
GitHubを使う目的
Git/GitHubを使う目的は、ドキュメントやプログラム開発の効率化のためです。 なにか失敗したときに元に戻したり、複数の人が協力してコードを書いたりするのが便利です。
ツールの紹介
Git はコマンドラインで実行できますが、GUIのツールを使ったほうが最初は楽です。 GitHubに対応したツールは以下のものがあります。
基本的な処理の流れ
基本的な処理の流れは以下の様な手順です。
軽めの変更で直接コミットする場合
JIRA課題を作成します
リポジトリをクローンします
コードやドキュメントを書いてcommitします。commitメッセージにはJIRA課題のID(SAR-XXX等)を入れます
完了したらJIRAの課題をクローズします
大きめの変更でレビューをしてほしい場合
JIRA課題を作成します
リポジトリをクローンします
ブランチを作成します。ブランチ名にはJIRA課題のID(SAR-XXX等)を含めます
コードやドキュメントを書いてcommitします。commitメッセージにはJIRA課題のID(SAR-XXX等)を入れます
Pull Requstを作成します
JIRA課題を「解決」し担当者を変更して、レビュー依頼をします
レビュワーはレビューしてOKだったらマージします
JIRA課題をクローズします
詳細な処理の流れ
上記の処理の流れでレビューありのパターンを詳細に説明します。
注釈
画面例は SourceTree です
1. JIRA課題を作成
変更の対象となるJIRAの課題を作成します。
詳細な手順は 課題の作成 を参照してください。
2. リポジトリをクローン
ｰ SourceTree などを立ち上げて、リポジトリをクローンします。 - リポジトリのURLが github のページにあるので、その URL を指定してクローンします。
3. ブランチを作成
Branch をクリック
New Branch にブランチ名を入力して Create Branch をクリック
ブランチ名にはチケット番号を入れます
ブランチを作成
4. コードをコミット
左上の Commit をクリック
コミットメッセージを入力して Commit をクリック
コミットメッセージにチケット番号を入れます
左下のチェックボックスをクリックすると、Commit と同時にサーバーに Push します
5. Pull Requstを作成
編集が完了したら、レビュー依頼するために Pull Request を作成します
github のリポジトリのページを開いて、自分が作成したブランチを default にマージするための Pull Request を作成します
下記の画面の場合は Compare & pull request をクリックします
次の画面で Create pull request を作成します
Pull Requestを作成
6. JIRA課題でレビュー依頼
JIRA課題を編集し、担当者をレビュワーに変更してレビューを依頼をします
チケットのコメントに Pull request の URL を記入してください
編集方法は 課題の編集 を参照してください
7. レビューしてマージ
レビュワーは内容が問題なければ、Pull request 上で Merge pull request をクリックしてマージします
Pull Requestをマージ
8. JIRA課題をクローズ
レビュワーは課題をクローズして終了です。