如果在了解和使用过程中,有任何疑问,非常欢迎提出宝贵的 Issue
PR的提交不限制范围,如代码、文档等修改均在允许范围内,可 参考这里 的PR提交
在以正确的姿势编写和管理代码文档中详细介绍了本项目产生的背景原因,和功能作用。或许它可以帮助你了解本项目
在提交代码前,至少需要做到以下几项
如果有单元测试,则整个项目的单元测试必须通过
规范使用如fix: 修复commit日志记录的bug
这种组合的提交规范
- fix: 修复bug相关
- doc: 文档完善相关
- refactor: 重大功能重构
- feat: 新功能、新组件等
- perf: 性能优化提升相关
- test: 新增测试或测试相关的修改
- style: 调整代码格式等对功能和性能无较大影响的修改
- chore: 构建过程或辅助工具的变动,如dockerfile的修改
代码统一先提交合至test
分支,在review通过后合入main
分支。在合入main
分支后,会自动生成一个来自release-please--branches--main--components--posture
分支的PR,合并这个自动PR即可。
main
:主分支test
:测试分支release-please--branches--main--components--posture
:版本自动发布专用分支,合入main
分支后会自动打包发布release
对于重要代码部分,请以评论的方式写清楚原因,可以参考 fix: 修复push钩子中对特定分支名截取的bug
本项目设置了自动release发布,不需要手动打包处理。