LimboAI社区贡献指南：从bug报告到代码提交的完整流程

LimboAI社区贡献指南：从bug报告到代码提交的完整流程

【免费下载链接】limboaiLimboAI - Behavior Trees and State Machines for Godot 4项目地址: https://gitcode.com/gh_mirrors/li/limboai

LimboAI是一个为Godot 4引擎提供行为树和状态机功能的开源项目，通过参与社区贡献，你可以帮助改进这个强大的AI工具，无论是报告bug、提交代码还是完善文档。本指南将带你了解从发现问题到成功贡献代码的完整流程，让你轻松成为LimboAI社区的一员。

1. 贡献前的准备工作 🚀

在开始贡献前，确保你的开发环境符合项目要求。LimboAI支持两种编译方式：作为Godot引擎模块或GDExtension库。

1.1 环境配置

• Godot引擎版本：使用最新稳定版Godot引擎，直到即将发布的版本出现第三个beta或候选版本。
• 代码风格：遵循Godot代码风格指南，使用clang-format保持一致的代码风格，并通过pre-commit install安装Git钩子实现自动化。

1.2 获取源代码

通过以下命令克隆LimboAI仓库：

git clone https://gitcode.com/gh_mirrors/li/limboai

2. 报告bug或提出功能建议 🐛

发现问题或有新功能想法时，清晰的报告是解决问题的第一步。

2.1 Bug报告要点

• 详细描述：包括复现步骤、预期结果和实际结果。
• 环境信息：Godot版本、LimboAI版本、操作系统等。
• 截图或视频：如果可能，提供问题的截图或录屏，帮助开发团队更好地理解问题。

2.2 功能建议

• 需求背景：说明为什么需要这个功能，解决什么问题。
• 实现思路：简要描述你认为的实现方式，或参考其他项目的类似功能。

3. 代码贡献流程 🔧

3.1 选择任务

• 查看项目的issue列表，选择标记为"good first issue"的任务，适合新手入门。
• 或根据自己的兴趣和能力，选择需要改进的功能或修复的bug。

3.2 开发与测试

3.2.1 编译方式

作为Godot模块编译：

1. 克隆Godot引擎仓库并切换到最新稳定标签：

   git clone https://github.com/godotengine/godot.git git checkout 4.3-stable # 替换为最新稳定标签

2. 将LimboAI克隆到modules/limboai目录：

   git clone https://gitcode.com/gh_mirrors/li/limboai modules/limboai

3. 参考Godot引擎文档进行编译。

作为GDExtension库编译：

1. 确保安装SCons构建工具和C++编译器。
2. 运行以下命令构建插件库：

   scons target=editor

   构建结果默认位于demo/addons/limboai/bin/目录。

3.2.2 单元测试

使用tests=yes构建选项编译单元测试，然后运行：

godot --test --tc="*[LimboAI]*"

确保你的代码通过所有测试。

3.3 提交代码

• 创建分支：从main分支创建新分支，命名格式如feature/xxx或bugfix/xxx。
• 提交信息：清晰描述提交内容，遵循约定式提交规范。
• 拉取请求：提交PR到LimboAI仓库，PR描述需说明解决的问题、实现的功能及测试情况。

4. 文档贡献 📝

完善的文档对项目至关重要，你可以通过以下方式贡献文档：

4.1 编辑RST文件

在线文档使用Sphinx构建，源文件位于doc/source目录（RST格式）。你可以：

• 修正现有文档的错误。
• 添加新功能的使用说明。
• 改进教程内容。

4.2 更新类文档

类文档位于doc_classes/目录的XML文件中。创建或修改类后：

1. 运行Godot二进制文件并使用--doctool选项生成或更新XML文件。
2. 运行scripts/update_rst.sh脚本生成RST文件（doc/source/classes目录下的RST文件不应手动编辑）。

5. 使用开发工具提高效率 🛠️

LimboAI提供了强大的编辑器和调试工具，帮助你更高效地开发和测试行为树。

LimboAI编辑器界面，展示了行为树的编辑和配置功能。

LimboAI调试器，可实时查看行为树节点的执行状态。

行为树编辑器与调试器结合使用，方便开发和调试复杂的AI逻辑。

6. 贡献注意事项 ⚠️

• 向后兼容：提交PR时确保小版本向后兼容。
• 兼容性：贡献需同时兼容模块和GDExtension两种编译方式，CI工作流会验证这一点。
• 代码审查：PR会经过代码审查，根据反馈进行修改，确保代码质量。

通过以上步骤，你可以顺利地为LimboAI项目做出贡献。无论是代码、文档还是bug报告，每一份贡献都能帮助LimboAI变得更好。加入我们，一起打造强大的Godot AI工具！

【免费下载链接】limboaiLimboAI - Behavior Trees and State Machines for Godot 4项目地址: https://gitcode.com/gh_mirrors/li/limboai