架构变更请求
架构变更请求让您通过结构化的审查工作流提出对 C4 模型的修改。团队成员不再直接编辑架构,而是创建可以被审查、讨论和合并的请求。
工作原理
变更请求将一个或多个对架构模型的修改建议分组。它遵循类似于代码仓库中 Pull Request 的生命周期:
- 创建 包含标题和描述的请求
- 添加变更 — 创建、更新或删除 C4 元素(系统、容器、组件、代码元素、关系、叠加层)
- 准备就绪时 提交审查
- 审查 — 团队成员批准、请求变更或留下评论
- 合并 将所有变更应用到实时架构
请求生命周期
每个请求经历以下状态:
| 状态 | 描述 |
|---|---|
| 草稿 | 正在进行中。只有作者可以查看和编辑变更。 |
| 开放 | 已提交审查。团队成员可以审查和评论。 |
| 已批准 | 已收到批准,准备合并。 |
| 已合并 | 变更已应用到架构模型。 |
| 已关闭 | 被拒绝或放弃。作者可以重新打开。 |
创建请求
从请求选项卡
- 导航到您的项目
- 打开 请求 选项卡
- 点击 新建请求
- 输入标题(最多 200 个字符)和可选描述
- 请求以 草稿 状态开始
添加变更
在草稿或开放的请求中,通过选择以下内容添加变更:
- 操作:创建、更新或删除
- 元素类型:系统、容器、组件、代码、关系或叠加层
- 元素数据:新建或修改元素的属性
变更按操作类型(创建、更新、删除)分组以便审查。
编辑请求
作者可以随时编辑请求的标题和描述,只要尚未合并。点击标题旁的铅笔图标进入编辑模式。
审查请求
提交审查
具有编辑权限的团队成员可以审查开放的请求:
- 批准 — 提案看起来不错
- 请求变更 — 合并前需要修改
- 评论 — 留下反馈但不做正式决定
活动动态
活动选项卡按时间顺序显示所有审查和评论。使用底部的评论编辑器留下快速评论,无需正式审查。
合并请求
当请求已被审查和批准后:
- 打开请求详情页
- 点击 合并
- 所有变更以原子方式应用到 C4 模型
只有具有编辑权限的团队成员可以合并请求。
预览变更
预览 选项卡显示变更应用后架构将呈现的视觉效果,让审查者在合并前了解影响。
最佳实践
编写清晰的标题
使用描述性标题解释意图:
- "添加支付服务和 Stripe 集成"
- "将单体 API 拆分为用户和订单服务"
- "移除已弃用的通知组件"
保持请求聚焦
- 每个请求一个逻辑变更
- 避免混合不相关的修改
- 较小的请求更容易审查
使用描述
解释提出变更的原因:
- 为什么需要这个架构变更
- 考虑了哪些替代方案
- 关联到相关的 ADR 或文档
合并前审查
- 建议至少获得一个批准
- 使用评论讨论权衡取舍
- 查看预览选项卡验证结果