仓库规范
Commit Message 规范
本仓库遵循 Angular Commit Log 规范
即:
<type>(<scope>):<subject>
- type 代表 commit 类型
feat:新功能
fix:修复缺陷
docs:文档
style: 格式(不影响代码运行的变动)
refactor:重构(即不是新增功能,也不是修改bug的代码变动)
test:增加测试
chore:构建过程或辅助工具的变动
ci: CI工具相关变动
build: 构建
perf: 优化相关的变动- scope 为可选项,说明本次 commit 的变更范围
- subject 为本次变更的描述, 请至少说清楚你做了什么!
Branch 规范
本仓库使用 Git 工作流分支分为 主分支、开发分支、功能分支和热修复分支,请严格遵守分支命名规则进行开发。
主分支 (The main branches)
主分支,永远是可用的稳定版本,不能直接在该分支上开发。 生命周期无限长。
开发分支 (Develop branches)
开发分支,所指向的源码总是处于为下次发版所做的最近的一次修改提交的状态。 生命周期无限长。
功能分支 (Feature branches)
分支创建自:develop;
必须合并回:develop;
分支命名约定:feature/*
合并后删除。
热修复分支 (Hotfix branches)
分支创建自:main;
必须合并回:develop和main;
分支命名约定:hotfix/*
合并后删除。
Pull Requests 规范
关于Pull Request中的描述,参考Pull Request模板,涵盖必要信息:
**本次 Pull Request 的包含的类型有哪些?**
**What type of PR is this?**
- [ ] API-change
- [ ] BUG
- [ ] Improvement
- [ ] Documentation
- [ ] Feature
- [ ] Test and CI
- [ ] Code Refactoring
**有哪些 issue 在本次 Pull Requests 中被解决?**
**Which issue(s) this PR fixes:**
issue #
**这次 PR 做了什么/ 我们为什么需要这次 PR ?**
**What this PR does / why we need it:**
**代码 Review 后的的特别说明**
**Special notes for your reviewer:**
**附加文档(如设计文档、使用文档等):**
**Additional documentation (e.g. design docs, usage docs, etc.):**
The job's not over until the paperwork's done.