Sponge API 及其实现的 Git 工作流程
开发 API
提交新变更的基本操作在 如何使用 Git/GitHub 一节中阐明。除此之外,我们建议你的新分支应当有一个有意义的名字。有鉴于我们使用的新分支模型,你应当注意你的拉取申请的基础分支和目标分支。关于分支和版本规范的内容请参阅:版本系统和项目仓库分支结构
另外,我们要求你必须确保所有模块可经过 gradle compileJava
编译。这条指令会产生一个源文件的简单构建。若成功通过编译,你便可以准备向 SpongeAPI 发起拉取请求。
开发 API 的实现
实现的提交和 API 的提交基本一致。首先,请按 如何使用 Git/GitHub 中的描述推送变更,同时记住,新分支的名字应当有一定含义。有鉴于我们使用的新分支模型,你应当注意你的拉取申请的基础分支和目标分支。关于分支和版本规范的内容请参阅:版本系统和项目仓库分支结构
同时,执行 gradle compileJava
以确认可通过编译。
修改实现有时会不可避免地修改 API 。我们当然理解这一点,但请务必保证在推送更新前, SpongeAPI 的指针和你的分支的基础分支一致。你可能需要在做出新变更前添加子模块(例如 git add SpongeAPI
和/或 git add Mixin
)来解决此问题。
一旦你的代码提交到了远程分支,你就可以发起新 Pull Request 。