OpenPoolはコントリビュータを歓迎します。
本ページでは、実際にコントリビュートするにはどうしたら良いかを解説します。
FORK
まず、GitHub のプロジェクトをフォークして、コピーを作成して下さい。OpenPoolでは、コードの質を保つために、devel (developmentの意味) ブランチをmasterブランチと分けています。ローカルのブランチは、必ずdevelブランチからcheckoutするようにしてください。そして、Pull requestは、develブランチに送るようにして下さい。
さらに、自分のコミットを管理するために、develSpikeのようなトピックブランチを作成することを推奨します。
1 2 3 4 5 |
$ git clone git@github.com:YOURNAME/openpool-core.git $ cd openpool-core $ git remote add openpool git@github.com:openpool/openpool-core.git $ git checkout -b devel remotes/openpool/devel $ git checkout -b develSpike |
COMMIT
良いコミットログを書くことは重要です。コミットは小規模で、かつ意味のある変更になるように注意し、プッシュする前にはまとめることを推奨します。
1 |
$ git commit -m "short comment" |
REBASE
git rebase
( git merge
ではありません) を使って、適宜リモートとローカルを同期させるようにしましょう。
1 2 |
$ git checkout -B devel remotes/openpool/devel $ git rebase devel develSpike |
TEST
コードをプッシュする前には、最低限 ant を走らせましょう。全てのビルドが通ることを確認して下さい。
1 2 3 |
$ cd resources $ ant resources/build.xml $ cd ../ |
くれぐれも、ビルドにコケるパッチは送らないでください!
PUSH
1 |
$ git push origin -f develSpike |
https://github.com/YOURNAME/openpool-core に言って、あなたのトピックブランチを選択します。「Pull Request」ボタンをクリックして、「devel」をベースブランチとして選び、フォームに記入します。
Pull requestは通常数日内にレビューされます。