Skip to content

Latest commit

 

History

History
44 lines (26 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

44 lines (26 loc) · 2.18 KB

向小米铁蛋贡献力量!

感谢您关注我们的项目。

About license

本项目遵守Apache 2.0开源协议。

成为开发者前

确保您已经签署个人独立贡献者许可协议(CLA)。如果已签署,请直接阅读开发者签名认证,如未签署,请继续往下读。

为环保和效率起见,目前只支持电子签署

电子签署方式

开发者签名认证

开发者需要使用签署CLA的邮箱对所提交修改进行签名,即使用git commit -s进行递交commit信息。

代码审查

所有递交都按照合入请求(Merge Requst)的方式进行,并只接收GitHub的拉取请求(Pull Request)的流程方式。

代码格式

所有ROS 2相关代码均遵从ROS 2的标准代码规范。可阅读Code style and language versions进行了解。建议在提交代码前,使用ament_lint 工具或借助colcon test进行快速审查。

分支管理

我们所有的仓库均分为两条分支进行开发,分别是develmain

  • devel分支用于日常的合入请求和每日版本的打包,属于开发分支。

  • main分支用于存放稳定版本,当且仅当需要发行新版本时,冻结devel分支,并从devel分支创建合入请求,并经过:

    • 撰写改动记录,梳理预发行的新功能和预修复的问题,确定版本号。
    • CI完全通过,包括构建和测试部分。
    • 测试工程师介入,并按照1中的新功能和预修复的问题进行摸底测试。如有问题,需要相关开发者按照修复问题的方式及时向devel分支递交修复代码。
    • 如测试通过,则对项目的代码和二进制包进行打包和封装。
    • Release界面进行发布。