コード開発においては、その作業フローが統一されていた方が状況を把握しやすく、開発がスムーズに行えます。ここでは自分自身で行っているGitHubを用いたコード開発のフローについて記載します。なお、ほとんど一人で開発しているので他人との共同作業は想定していません。
開発のフロー
ステップ1: GitHubでリポジトリの作成
新しいプロジェクトを始める時は、まずGitHubで新しいリポジトリを作成します。リポジトリ名は明確で、プロジェクトの内容をよく表すものにします。
ステップ2: Sublime Mergeでリポジトリのクローン
次にSublime Mergeを使用してリポジトリをローカルにクローンします。これにより認証時のトラブルを防ぎます。異なるGitクライアントを用いていると、予期せず異なる認証でGitHubに接続を試みてしまう場合がありそれを防ぐためにクライアントは統一します。
ステップ3: Issueの作成
作業を開始する前にGitHubでIssueを作成します。Issueの件名は作業内容を簡潔に説明するものとし、Issueの件名および説明欄は英語で記入します。
ステップ4: ブランチの作成
Issue作成後、GitHub状の同ページの[Development]欄に現れる[Create a branch]リンクをクリックし、新しいブランチを作成します。ブランチ名は「issue-#123」の形式にします。ここで#123は作成されたIssueの番号で、Issue名の後に付与されているものです。
ブランチ名を間違えた場合は、GitHubの[Code]欄のブランチ名のプルダウンメニューの横にある[X branches]をクリックし、ブランチの一覧を表示した後、該当ブランチの欄のペンマークをクリックすると修正できます。
ステップ5: ブランチのチェックアウト
Sublime Mergeを開き、新しく作成したブランチをローカルにチェックアウトします。左側メニューの[REMOTES]欄にある[origin]から、該当するブランチを右クリックし、[Create Local Branch from …]をクリックします。
Sublime Mergeの上部中央に現在作業しているブランチ名がでるので、ブランチが該当するIssueに対応したものになっていることを確認します。Sublime Textの右下にもブランチ名が表示されるのでブランチ名を確認します。
ステップ6: 更新履歴の追加
作業を始める前に、Sublime TextでREADME.mdを開き、更新履歴セクションに作業日、ブランチ名（その際右下のブランチ名を確認する）を記入し、そのブランチでの作業目的を記載します。README.mdは日本語での記載で可とします。
ステップ7: 編集作業
ブランチでの作業を開始します。作業中は定期的に変更をコミットします。
ステップ8: プッシュとプルリクエストの作成
変更をリモートリポジトリにプッシュした後、GitHubで[Compare & pull request]をクリックし、プルリクエストを作成します。
プルリクエストの件名欄にIssueの件名が表示されるので必要があればそれを修正します。件名の最後に付与される#のついた番号はあとで修正内容を確認する際のリンクになるので消さないよう気をつけます。
ステップ9: コードレビューとマージ
最後に、自身でコードレビューをします。レビューが完了し、問題がなければ[Squash and merge]をクリックしてマージを行います。
[Squash and merge]を押した後にマージの件名欄が表示され、初期状態でプルリクエストの件名が表示されるので再度確認し、問題がなければマージします。マージの件名がCommitの件名としてリポジトリに残るので間違いがないように気をつけます。
