-
gitlab分支管理规范
分支说明:
测试代码库共有三个分支,main分支、dev分支、release分支
-- main分支:存放运行稳定的最新代码 ,一般不直接将未审核的代码合入到main分支
-- dev分支:存放个人开发的用例脚本,可用于用例故障修复,新的用例开发等
-- release分支:对应上线的产品版本,在发布上线产品时,同步从main分支拉取得到该release分支
分支merge说明:
-- dev分支用例代码开发完成并执行成功后,从各自的dev分支merge到main分支
-- merge request过程中需要注意将assignee和reviewer指派为同组内其它小伙伴,待审核通过后即可merge到main分支
-- merge前一定要确保分支代码是最新的,避免删减或修改掉其他小伙伴的代码
-- merge发起人负责解决代码合并过程中出现的conflict -
gitlab提交代码规范
1.使用分支和合并策略 a. 使用分支:每个新功能或修复应当在单独的分支上进行开发,分支命令规范,例:hel-dev。 b. 合并前测试:在合并代码到主分支之前,确保所有提交的py文件在本地运行都通过后再提交。 c. 代码审查:合并之前,应当经过代码审查(Code Review),以确保代码质量和一致性。
2.提交信息规范,commit信息应当简洁明了,包含以下几个部分: a. 简短的标题:简要描述本次提交的内容。 b. 详细描述:对提交内容进行详细说明,必要时包含上下文信息。 c. 问题追踪:如修复或更改因项目接口更新而导致的问题。 例: 添加用户登录接口的自动化测试脚本
o增加了 login_test.py 文件
o添加了基本的登录接口测试用例,包括成功登录和失败登录的测试
o更新了 README 文件,增加了接口测试的说明
3.提交频率和粒度 a. 单一目的:每次提交应当专注于单一目的或任务,如添加一个新功能、修复一个 bug 或重构代码。 b. 小而频繁:提交应当保持小而频繁(如新增了一个接口的用例或修改了多个接口的用例,单次提交不超过3个py文件),这样可以更容易地追踪更改并减少冲突。(但要避免过度提交,例如:修改注释)
4.代码风格和格式化 a. 遵循代码风格指南:例如,PEP 8 是 Python 代码的风格指南。确保代码符合团队约定的风格指南。参见:https://alidocs.dingtalk.com/i/nodes/gwva2dxOW4Kpd4egs6A4ZBQm8bkz3BRL?corpId=ding83b4c2160bab5111&doc_type=wiki_doc&iframeQuery=utm_source%3Dportal%26utm_medium%3Dportal_new_tab_open&rnd=0.8090448653335316&sideCollapsed=true&utm_scene=team_space b. 代码格式化:若使用pycharm可使用shirt+ctrl+alt+L来格式化代码;或使用如 black、flake8 或 pylint 等工具来自动格式化代码和检查代码质量。
5.代码注释 a. 代码文档化:在提交代码时,确保代码有适当的注释和文档。特别是对于复杂的逻辑和关键的接口。 b. 更新相关文档:如果提交的更改影响了项目的文档,如 README 或接口文档,确保同步更新这些文档。
6.避免提交敏感信息 a. 确保不将敏感信息提交到版本控制系统中(例如:本项目的数据库连接密码)