Documentation

貢献

はじめに

Fuel はコミュニティ駆動のフレームワークであり、 フレームワークを改良したり機能を追加し、フレームワークをより高いレベルにしたいと考える誰からの貢献に対してもオープンです。 それらを達成するには、チュートリアルを書くこと、パッケージをリリースすること、 Fuel の公式な部分への貢献すること (Core、Orm、ドキュメント、など) のように複数の方法があります。

コードによる貢献

バグに遭遇したり、issue リストにあなたが解決したものを見つけた場合、 そしてあなたがフレームワークに貢献し返したいなら、GitHub を使い Pull Request を送ってください。 あなたが使っているバージョンにより、Pull Request するブランチが異なります。 Pull Request するときは、次のステップに従ってください:

• まだ、そのバージョンはサポートされていますか?
  されていない場合は、サポートされているバージョンにアップグレードして、バグがまだ存在するかどうか確認してください。
• 最新バージョンでも、バグが再現されますか？
  最新の開発ブランチにアップデートして、バグがまだ再現されるかを確認してください。
• 最新の開発ブランチでもバグが存在する場合は、それをローカルにチェックアウトします
  $ git checkout -b 1.9/develop origin/1.9/develop
• バグを修正しローカルリポジトリにコミットします
  説明的で分かりやすいコミットメッセージを記述し、確認しコミットします
  $ git commit -m "This is my awesome description."
• あなたの GitHub のアカウントに push する
  $ git push
• pull をリクエストする
  Pull Request は、あなたがいるブランチ (最新の開発ブランチ) にしてください。 "update commit range" インターフェイスを利用して、あなたの Pull Request を正しいブランチ宛にしてください。 Pull Requestは現在のリリース開発ブランチ (1.8/develop) のみ受け付けます。
• 名誉を待つ
  Pull Request がマージされる際には、あなたの名前は、貢献者のリストの一部となるでしょう。

Githubのwikiで上記手順の詳細を確認することができます。

バグでない貢献

バグでない貢献とは、新機能、最適化その他のすべての変更です。それらの Pull Request はすべて 最新の開発ブランチになされる必要があります。 1.9/develop ブランチをプルし、変更し Pull Request を送ってください。

大きな変更、新しい機能の実装、または開発に時間のかかる機能に関しては、独立したブランチを設定します。 電子メールまたはIRCを利用して、その機能についてコア開発者と連絡を取ってください。