Skip to content

Latest commit

 

History

History
49 lines (29 loc) · 1.55 KB

CONTRIBUTING-zh.md

File metadata and controls

49 lines (29 loc) · 1.55 KB

如何为该项目做出贡献

首先,感谢您对该项目感兴趣并愿意做出贡献!

目录

代码风格

请遵循我们的代码风格指南以保持代码的一致性。

提交更改

如果您想提交代码更改,请遵循以下步骤:

  1. main分支 fork 本项目。
  2. 创建一个新的分支来处理您的更改。
  3. 确保您的代码遵循我们的代码风格。
  4. 提交您的更改到您的fork。
  5. 创建一个Pull Request(PR)到我们的主分支。

测试

对于你的代码,无论是GDScript还是Rust都需要编写适当的测试来覆盖你的代码,我们使用Github Action来运行测试

关于Rust的测试的指引

我们会运行一些Godot场景来检查基本的错误,要运行的Godot场景被记录于test_scene中,在日常开发中,你可以通过运行script/godot_test.py来进行基础的测试

我们还提供了一些功能用于更好地测试项目的开发,列举如下:

  • 你可以建立 debug/sword 文件,并在里面写下需要测试的剑的名字,运行时就会自动读取并优先运行该剑

版本控制

请使用约定式提交来书写您的提交。

其他资源


我们期待您的贡献,并希望您在参与过程中感到愉快和有成就感。