开发文档贡献
开始指南
介绍 Rebar 附属组件开发的基础知识
最后更新时间
开始指南
Rebar 使用 Kotlin 编写。Kotlin 和 Java 很像,但语法更现代、更简洁。有 Java 基础的话,上手 Kotlin 会非常快。
Pylon 本身则使用 Java 编写。
如何开始
- 克隆
parallel-dev-repo仓库:git clone https://github.com/pylonmc/parallel-dev-repo(也可以用 GitHub Desktop 等图形界面工具) - 如果你用 IntelliJ,打开项目后会自动完成所有配置。否则请手动运行
./gradlew,它会自动克隆rebar和pylon仓库。 - 如果你想向主项目提交代码,需要删掉
rebar或pylon目录(取决于你要贡献哪个项目),然后 fork 对应的仓库,把你的 fork 克隆到同一目录下。 不这样做的话你没法开 PR(除非你是 Rebar/Pylon 的核心开发者,有对应仓库的写权限)。
关于主仓库的更多说明,请参阅并行开发仓库项目。
提交贡献
我们欢迎任何对 Rebar 和 Pylon 的贡献。不过在大改动之前,建议先和 Pylon 团队沟通一下——有些功能可能已经在计划中了,提前确认可以避免重复劳动。如果你打算做比较大的改动,或者对贡献流程有任何疑问,欢迎来我们的 Discord 聊聊 :)
改好之后,开一个 PR 并说明你改了什么、为什么这样改。
测试
Rebar 有一套集成测试。一般来说只需要为关键功能(如方块存储和配方)添加测试即可。
自定义 Dokka
Pylon 用了一个定制版的 Dokka 来生成 Javadocs,因为官方版本的输出有不少问题,效果也不太理想。Seggan 已经向 Dokka 上游提了修复 PR,但还没合并,所以暂时先用自定义版本。如果你想体验修复后的文档效果,按以下步骤操作:
- 克隆
pylonmc/dokka仓库:git clone https://github.com/pylonmc/dokka - 切换到
pylon分支:git checkout pylon - 在根目录执行
./gradlew publishToMavenLocal -Pversion=2.1.0-pylon-SNAPSHOT。注意 Dokka 项目很大,首次构建会比较慢,大概需要 10 分钟左右。之后只要不清理构建缓存,增量构建会快很多。 - 回到 Pylon 主项目,执行
./gradlew :rebar:rebar:dokkaGenerate -PusePylonDokka=true。生成的文档在pylon/rebar/rebar/build/dokka目录下。
卡住了怎么办?
- 先判断是不是 Pylon 特有的问题——如果是就查文档,不是就用搜索引擎搜
- 去对应仓库的 Issues 里看看有没有人遇到过同样的问题
- 在我们的 Discord 服务器里搜索相关关键词,看看之前有没有讨论过
- 以上都找不到答案的话,直接在 Discord 上提问