LuminolMC/docs/CONTRIBUTING.md

为Luminol贡献代码

English | 中文

我们很开心您想为我们的项目做出贡献！一般来说，我们对PR的审核是十分宽松的； 但是如果您可以遵守下列的规则，我们可以更快地完成审核。

使用个人账户进行 Fork

我们会定期尝试合并已有的 PR，如果有一些小问题，会尝试帮您解决这些问题。

但是如果您使用了组织账号进行 PR，我们就不能对您的 PR 进行修改了。因此我们只能关闭你的PR然后进行手动合并。

所以，请不要使用组织账号进行 Fork！

您可以看看 这个 Issue 来了解一下我们为什么无法修改组织账号的 PR。

开发环境

在开始开发之前，您首先需要拥有以下软件作为开发环境：

• git
• JDK 21 或更高版本

了解补丁（Patches）

Luminol 使用和 Folia 一样的补丁系统，并为了针对不同部分的修改分成了两个目录：

• luminol-api - 对 Folia-API / Paper-API / Spigot-API / Bukkit-API 进行的修改。
• luminol-server - 对 Minecraft 标准服务器原有逻辑进行的修改。

补丁系统是基于 git 的，你可以在这里了解 git 的基本内容: https://git-scm.com/docs/gittutorial

如果你已经 Fork 了主储存库，那么下面你应该这么做：

1. 将你的仓库 clone 到本地；
2. 在你的 IDE 或 终端 内执行 Gradle 的 applyAllPatches 任务，如果是在终端内，你可以执行 ./gradlew applyAllPatches；
3. 在执行操作后，仓库根目录下应该存在以下目录对： luminol-api 和 luminol-server ， folia-api 和 folia-server ， 以及 paper-api 和 paper-server（下文称作 *-api 和 *-server ）；
4. 进入 仓库根目录下的 *-api 和 *-server 文件夹进行修改。

以下为对上述各个文件夹的简单描述，详细描述可以参考这里：

1. API部分

• luminol-api ：暂无有效文件
• folia-api ：对folia-API的修改应当在此文件夹下进行
• paper-api ：对paper-API/spigot-API/bukkit-API的修改应该在此文件夹下进行

2. Server部分

• luminol-server ：对Minecraft原版服务器的修改应当在此文件夹下进行
• folia-server ：暂无有效文件
• paper-server ：对于非原版的对服务器逻辑的修改应当在此文件夹下进行

顺便一提，仓库根目录下的 *-api 和 *-server 并不是正常的 git 仓库：

• 在应用补丁前，基点将会指向未被更改的源码
• 在基点后的每一个提交都是一个补丁
• 只有在 Folia 最后一个提交后的提交才会被视为 luminol 补丁

增加补丁

按照以下步骤增加一个补丁是非常简单的：

1. 对 *-api 和 *-server 进行修改；
2. 使用 git 添加你的修改，比如 git add .（不要提交新建的文件的修改）；
3. 使用 git commit -m <提交信息> 进行提交；
4. 运行 Gradle 任务 fixupPaperApiFilePatches 生成新建文件的补丁文件（注意不要提交）；
5. 运行 Gradle 任务 rebuildAllServerPatches 将你的提交转化为一个补丁；
6. 将你生成的补丁文件进行推送。

这样做以后，你就可以将你的补丁文件进行 PR 提交。

修改补丁

你可以使用以下方法来修改一个补丁的内容：

1. 在 HEAD 上直接进行修改；
2. 使用 git commit -a --fixup <hash> 来进行一个更正提交；（不要提交对在luminol新建文件的修改）
   • 如果你想要更改提交信息，你也可以用 --squash 来代替 --fixup。
3. 使用 git rebase -i --autosquash base 来进行自动变基，你只需要输入 :q 来关闭确认页面即可；
4. 运行 Gradle 任务 fixupPaperApiFilePatches 来修改已被修改的在luminol新建文件的补丁（注意不要提交）；
5. 运行 Gradle 任务 rebuildAllServerPatches 来修改已被修改的补丁；
6. 将修改后的补丁 PR 发回储存库。