本文档参考了Git提交规范,旨在规范使用SVN进行代码版本管理时的提交操作。
提交前的准备
1. 检查代码
在提交代码前,请先进行必要的代码检查,确保代码的正确性、可读性和可维护性。可以使用代码质量管理工具进行自动化检查,也可以手动检查。
2. 编写提交信息
在提交代码时,需要编写提交信息来描述本次提交的内容。提交信息应包括以下内容:
- 本次提交的目的或原因
- 本次提交的变更内容
- 其他有关本次提交的说明信息
提交信息应遵循以下格式:
<type>(<scope>): <subject>
<body>
<footer>
其中,<type>
代表本次提交的类型,包括以下几种:
- feat:新功能(feature)
- fix:修补 Bug
- docs:文档(documentation)
- style:格式(不影响代码运行的变动)
- refactor:重构(即不是新增功能,也不是修改 bug 的代码变动)
- test:增加测试
- chore:构建过程或辅助工具的变动
<scope>
代表本次提交的影响范围,可以省略。
<subject>