コントリビューション ガイドライン

警告

This documentation refers to an outdated SpongeAPI version and is no longer actively maintained. While the code examples still work for that API version, the policies, guidelines, and some links may have changed. Please refer to the latest version of the documentation for those.

開発者達によるSpongeAPIの改良の支援の需要は常に存在しています。 完璧なプロジェクトなどはなく、常に改善することができます。 もしあなたが開発者でかつ支援に興味があるなら、躊躇しないでください。 ただあなたが私達のガイドラインに従っていることを確認するだけです。

注釈

プロジェクトに対する貢献の決意と一貫性を示す開発者は、チームリーダーによる裁量でSpongeスタッフへの参加を招待するかもしれません。 正式な申請手順は存在しません。 スタッフに頼まないでください。私達があなたに頼みます。

一般的な手順

  1. 開発環境の準備 で説明したように、ワークスペースを構築します。

  2. あなたがGitとGitHubに精通していることを確認してください。 あなたの知識を新たにする必要がある場合、ここを見てください。: Git(Hub) の使い方

  3. SpongeAPI, SpongeCommon, SpongeForge, SpongeVanilla, そして SpongeDocs のリポジトリの既存のIssuesを確認してください。 他の誰かが既に同じことをしている可能性があります。 また、あなたの助けが必要な既存の問題については、`「help wanted」 <https://github.com/SpongePowered/SpongeAPI/labels/help%20wanted>のラベルが付いたIssue`_を確認してください。

注釈

20行以下の小さな変更で、Pull Requestを送らないでください。 代わりに、#sponge on IRC (irc.esper.net) か`#spongedev on IRC (irc.esper.net) <https://webchat.esper.net/?channels=spongedev>`_ に参加してください。 私達が他の小さな変更と共にその変更を適用します。

  1. その問題がより大きな変更を必要とする場合、最初は必要な変更無しにIssuesを送ってしまいたくなるかもしれません。 それにより、私達はその問題を確認し、あなたがそれを修正しようとしていることを知ることができます。 さらに、 ``[WIP]``と先頭に付けた、WIP(作業中) のPull Requestを早期に作るべきです。 結果、私達は既にレビューを開始することができます。

  2. プロジェクトをフォークし、クローンして追加したブランチで変更を行います。

  3. 変更をテストして、(コンパイルできることを確認して！)、あなたのフォークにそれをコッミットしてプッシュしてください。

  4. 何を変更したかと何故その方法で変更されるべきかの短い概要と共にPull Requestを送ってください。

  5. 追加の変更を行う場合、あなたのブランチに新しいコミットをプッシュしてください。 あなたの変更をsquashしないでください。 それはあなたのPull Requestの前のバージョンと比較して、何を変更したのかを比較するのを非常に困難にします。

  6. あなたのPull Requestが、マージしようとしているブランチの最新の変更にリベースされていることを確認してください。 それをリベースするのに助けが必要なら、頼んでください！

ちなみに

どのブランチに基づいて作業をするべきかわからない場合、Pull Requestを送信する前に:doc:`versioning`について読んでください。