Skip to content

CONTRIBUTING.cn.md

Latest commit

 

History

History
49 lines (41 loc) · 2.72 KB

CONTRIBUTING.cn.md

File metadata and controls

49 lines (41 loc) · 2.72 KB

贡献指南 | Contribution Guide

配置你的 IDEA

  1. 导入 Java 代码样式配置（必须）
    • 此处查看
    • 设置 -> 编辑器 -> 代码样式 -> Java -> 方案 -> 导入方案
  2. 导入配色方案（可选）
    • 此处查看
    • 设置 -> 编辑器 -> 配色方案 -> 导入方案
  3. 添加 CheckStyle-IDEA 插件（可选）
    • 插件 -> Marketplace
    • 搜索由 Jamie Shiell 制作的 CheckStyle-IDEA 插件并应用
    • 设置 -> 工具 -> CheckStyle -> Configuration File -> +/添加 -> 选择项目根目录下的 style.xml 文件
    • 设置 -> 工具 -> CheckStyle -> Configuration File -> 将除刚添加的条目外的其它条目取消勾选

各类注解的使用

  1. 在所有软件包下放置 package-info.java 文件，并在其中为软件包添加以下注解
    • net.minecraft.MethodsReturnNonnullByDefault
    • javax.annotation.ParametersAreNonnullByDefault
  2. 对于需要表示为 null 的参数/字段/返回值等，请使用 javax.annotation.Nullable

提交规范

  1. 提交时，请使用 git commit -m "commit message" 的格式
  2. 如果该 commit 是对于 issue 的解决或修复，请在 commit message 中填写 #issue number
  3. 我们不限制在 commit message 中使用的语言，但请至少包含一个英文的简单描述，并将其放置在其它语言的描述之前
  4. 如果你在 dev.dubhe.anvilcraft.api 软件包中添加了新的类和公开方法，请为他们添加完善的 Javadoc， 如果你修改了此软件包内的任何公开或非公开的方法，请保证它们的二进制兼容性

Pull requests

  1. Pull requests 标题应至少包含一个英文的简单描述，并将其放置在其它语言标题之前
  2. 你应在 Pull requests 的描述中详细解释你所做的更改
  3. 你应在 Pull requests 的描述中使用 fixed 或 resolved 链接对应的 issue
  4. 以下是一个简单的 Pull requests 示例 
    • ### Fix drop of mob amber blocks 修复生物琥珀块挖掘掉落物问题
- 修复了 #1533 的问题。
- 现在挖掘含生物琥珀块时，会正确地保存其包含生物的数据。
- 修复了部分数据与语言文件的错误。
- fixed #1533

    • Fix drop of mob amber blocks 修复生物琥珀块挖掘掉落物问题

      • 修复了 #1533 的问题。
      • 现在挖掘含生物琥珀块时，会正确地保存其包含生物的数据。
      • 修复了部分数据与语言文件的错误。
      • fixed #1533