Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
73 lines (47 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

73 lines (47 loc) · 1.75 KB
Raw

贡献指南

感谢你对相变晶 (PhasetransCrystal) 的关注！

贡献方式

🐛 报告 Bug

  1. 在对应仓库的 Issues 中搜索，确认问题未被报告
  2. 使用 Bug Report 模板，填写：MC 版本、模组版本、复现步骤、日志
  3. 上传 logs/debug.log 或崩溃报告

💡 功能建议

  • 使用 Feature Request 模板
  • 说明动机和使用场景，而非仅描述"想要什么"
  • 大型功能建议先到 Discussions 讨论架构

🔧 代码贡献

准备工作

git clone https://github.com/PhasetransCrystal/<repo>.git
cd <repo>
# 使用 GradleWrapper，无需手动安装 Gradle
./gradlew build

开发要求

  • Java 25，Gradle 9.6.1 + NeoGradle
  • 代码风格：Google Java Style，Spotless 自动检查
  • 提交前运行：./gradlew test && ./gradlew spotlessCheck
  • 目标平台：NeoForge，Minecraft 26.1.2

PR 流程

  1. 从 preview 分支创建功能分支
  2. 遵循 Conventional Commits：feat: / fix: / docs: / refactor:
  3. 确保 CI（build + spotless + test）全部通过
  4. 填写 PR 模板，关联相关 Issue
  5. 等待 Review，可能需要迭代修改

🎨 资产贡献

纹理、模型、音效、语言文件使用 CC BY-NC-SA 4.0 许可证，提交即表示同意此许可。

📖 文档贡献

文档站使用 Docusaurus，源码在 website/ 目录。

cd website
pnpm install
pnpm start

第三方 DLC 开发

基于 BreakdownKernel 开发第三方 DLC 请参考组织首页的详细建议。

行为准则

参与本项目即表示同意遵守贡献者行为准则。

相变晶 (PhasetransCrystal) · LGPL v3 & CC BY-NC-SA