贡献指南¶
为 FiveAges Sim 仓库贡献内容的指南。
行为准则¶
在所有交流中保持尊重与建设性。
贡献方式¶
缺陷报告¶
提交 issue 时请包含：
清晰描述问题的标题
复现步骤
预期行为与实际行为
环境信息（Ubuntu 版本、ROS 2 发行版）
功能请求¶
创建 issue 并说明：
使用场景与动机
建议方案
已考虑的替代方案
代码贡献¶
Fork 仓库
创建功能分支
进行修改
充分测试
提交 pull request
文档¶
修正错别字或不清晰的说明
补充缺失的文档
改进示例
编辑本 Sphinx 站点时，遵循
.cursor/skills/docs-writing/SKILL.md（事实来自所链 README；读者页不要写给 agent 的元说明）
开发环境搭建¶
克隆与构建¶
git clone https://github.com/fiveages-sim/<repo>.git
cd <repo>
# Follow repository-specific setup
colcon build
代码风格¶
遵循现有代码风格
使用有意义的变量名
为复杂逻辑添加注释
保持函数职责单一
测试¶
提交前在本地测试更改
为新功能添加单元测试
确保现有测试通过
Pull Request 流程¶
提交前检查¶
代码能够无错误地构建
测试通过
如有需要，已更新文档
提交信息清晰明确
PR 描述¶
请包含：
更改摘要
相关 issue（如有）
已进行的测试
破坏性变更（如有）
审查流程¶
维护者审查代码
处理反馈意见
批准并合并
提交信息¶
使用清晰、描述性的提交信息：
Add support for new gripper model
- Add URDF for XYZ gripper
- Implement hardware interface plugin
- Add launch file integration
Closes #123
许可协议¶
贡献内容将遵循仓库的许可协议。请确保你有权贡献这些代码。
待完成
组织范围内的贡献指南与 CLA 流程尚待最终确定。