开发者注意事项
编码规范
主要采用linux kernel的规范, 但是统一使用4个空格作为缩进, 注释使用统一的单行注释.
开发环境
使用git
下载仓库后, cmake -B build -DQQMUSIC_API_BUILD_TYPE=DEMO && cmake --build build
, 此时会构建与api库动态链接的
可执行文件, 可以利用demo/main.cc
进行调试(该文件在.gitignore
中, 更改不会被提交, 专门用于调试)
关于curl库, 请参考everything curl文档
api接口规范
- 所有的入参和返回参数当作函数参数, 返回值需要设置成
qqmusic/error.h
中的error
枚举类, 代表报错信息, 函数原型举例:
qqmusic::result get_song_list(std::string url, std::string& res_json);
提交规范
从issue
新建分支时请基于dev
分支构建. 一个分支对应一个issue
, 只完成issue
规定的任务.
分支名称遵循一下规则:
branch_type/module/issue
-
主分支(Main Branch) – 主分支通常是master或者main,用于存储稳定、可发布的代码
-
开发分支(Develop Branch) – 必须是可编译的代码, 其他开发分支从
dev
分支派生 -
特性分支(Feature Branch) – 从主分支创建的特性分支命名通常以feat/开头, 后接特性的简短描述, 例如:
feat/ui/new-login-page
-
修复分支(Bugfix Branch) – 从主分支创建的修复分支命名通常以fix/开头, 后接修复的问题的简短描述, 例如:
bugfix/backend/fix-login-issue
-
热修复分支(Hotfix Branch) – 从主分支创建的热修复分支命名通常以hfix/开头, 后接修复的问题的简短描述, 例如:
hfix/security/fix-security-issue
编写代码的过程中尽量多commit
, 便于回滚, 并且时常更新dev
分支的内容保持最新, 可以使用以下命令
git pull --rebase origin dev
任务完成后需要合并进入dev
分支, 并关闭issue
.
提交规范: 约定式提交规范
请在各人的分支中进行操作, 不要自行合并, 进行第一次代码提交后就可以向dev
分支提出合并请求.