提交拉取请求

警告

本文档是针对旧版 SpongeAPI 编写的，目前已不再维护。虽然相应的代码依然能在对应的 API 下工作，但相关政策、方针及链接可能有所变化。请在必要时参阅最新的文档获得相关信息。

基础知识

首先你需要设置你的机器以能够开发与使用 Sponge：

• 阅读 为开发作准备 并设置你的机器

• 熟悉 git 和 GitHub：如何使用 Git/GitHub

• 阅读我们的 代码规范 和 贡献指南

• 熟悉我们的 Sponge API 及其实现的 Git 工作流程

当你完成并感觉你已经做好 Sponge 开发的准备时，决定你想参与哪个部分的工作。

PR 编写

修复 Bug

用几句话说明：

• 你遇到的漏洞，尤其是

  • 它的表现

  • 你认为它应该如何表现

• 你修复了什么

• 你怎么修复的

API 重大补充

你已经开发了相当重大的 API 补充并且想作为一个 PR 进行提交。这很好！建设性的 PR 会让这个项目变得更好。但这也需要我们去书写美妙的 PR 描述。

过去有一些在标准之上和超越了标准的例子，如：

• Inventory API PR

• Data API PR

当然，上述是一些极端例子，以下是一些已被接受的 PR，它们可以作为在 PR 描述中应该包含什么内容的一个好的标准：

• Event Filtering PR

• Bans improvement API PR

从以上例子中可以采用到的几个点：

• 在 PR 的开头清楚地给出任何其它实现的 PR 的链接，这个可以用 GitHub 的 Markdown 做到。

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

• 对 API PR 的目的作一个清楚的描述，根据其功能写一个简短的概括，就好像写一篇短文，至多 4 个句子。

• 举出插件如何能使用这个新特性的代码示例（如果已经存在旧特性，说明为什么要更改它们）。