共有リポジトリのルール¶
概要¶
このドキュメントは OpenPNE3 開発の共有リポジトリを扱うためのルールについて説明しています。
共有リポジトリを扱う場合、すべての人はこのルールに従わなくてはなりません。
共有リポジトリの場所¶
git://github.com/openpne/OpenPNE3.git
ブランチ¶
共有リポジトリでは、利用者の利便性を考慮して、ブランチをリリースブランチ (master 含む) に限定するべきです。作業用のブランチを push してはなりません。作業用のブランチは自分のリポジトリで作成してください。
masterブランチ¶
開発版の機能追加やバグフィックス、成果物のマージ(取り込み)などがおこなわれています。
stable-3.x.xブランチ¶
安定版のメンテナンス(バグ修正など)をおこなうためのブランチです。あるバージョンで修正するべきバグなどの対応が一通り完了した場合、このブランチの特定リビジョンにtagを付け、リリースされます。
共有リポジトリに対する push 権限¶
以下に示す GitHub アカウントの所有者は、共有リポジトリに対する push 操作を実行することができます(2014 年 6 月 23 日現在)。
もしあなたが push 権限を得るに相応しいと思うのであれば、あなたの GitHub のアカウントを balibali, nishizoe, ShinichiU, tejima のいずれかのユーザに連絡してください。
コミット¶
直接のコミット¶
直接のコミットはいくつかの例外を除き認められません。
リリースマネージャーはリリース作業においては直接コミットをおこなうことができます。
それ以外の場合は、どんな人でも自身の clone において作業をしなくてはなりません。
コミットメッセージ¶
マージの際、コミットメッセージは以下のルールに従っていなければなりません。- メッセージは必ず英語または日本語で記載してください。メッセージは他の言語を含むこともできますが、その場合は英語または日本語で説明をしなければなりません。
- メッセージは関連するチケットの ID を含んでください。 ID は 「refs」や「fixes」というキーワードを伴って指定してください。これを守るための有用なフックスクリプトを用意してあります: http://gist.github.com/202866
例) "Added ability to delete member from the mobile_backend application (refs #1)", "Added ability to configure gadgets from the mobile_backend application. Adding support to manage SNS from mobile is now completed. (fixes #1)" - メッセージは必ずそのコミットが何であるかの説明となるようにしてください。
このルールに従わないコミットは、たいていの場合拒絶されるでしょう。
マージ¶
プルリクエストのマージは、テスト完了後に行います。マージ後は関連するチケットのステータス Fixed(完了)にしてください(コミットメッセージが fixes キーワードによってチケットと関連づけられている場合、ステータスの変更は自動的におこなわれます)。