プルリクエストを送る

警告

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.

基本

はじめにSpongeを開発できるようにコンピューターをセットアップする必要があります。

• 開発環境の準備 を読んでコンピュータをセットアップする

• Git(Hub) の使い方 でgitとGitHubについて知る

• Code Style page と コントリビューション ガイドライン を読む

• API と実装の Git ワークフロー について知る

十分に理解してSpongeを開発する準備ができたら、どの部分を開発するか決めましょう。

プルリクエストを書く

バグの修正

以下の文章で説明しましょう。

• どんな特定の状況で発生したバグか

  • どんな動作をしたか

  • どんな動作をすれば正しいか

• 何を修正したか

• どのように修正したか

主要なAPIの追加

プルリクエストとして送信したいような、かなり大きな追加APIを開発しましたか？すばらしい！建設的なプルリクエストは、このプロジェクトをより良くして行きます。そのためにも、ぜひともすばらしきプルリクエストを送ってください。

過去には、標準機能を期待以上に上回るすばらしい例がいくつかありました。その例は次のとおりです。

• Inventory APIのプルリクエスト

• Data APIのプルリクエスト

もちろん、上記の例は極端でしたが、プルリクエストとして送信すべき水準を満たしている例は次の通りです。

• Event Filteringのプリリクエスト

• Bans improvement APIのプルリクエスト

以下の項目も参考にしてください。

• プルリクエストのトップにある明確なビューで実装PRにリンクしてください。これはGitHub Markdownで実現できます。

*SpongeAPI*|[SpongeCommon](html link)|[SpongeForge](html link)|[SpongeVanilla](html link)

• APIへのプルリクエストで何をしようとしているのか、概要で明確に説明してください。これは、やりたいことの機能にもよりますが、最大4文までのエッセイを書くような簡単な要約です。

• プラグインがどのように新しい機能を使用できるか、コードの使用例を明確に示してください (すでにその機能が存在する場合は、なぜ変更が必要なのかも述べます) 。