提交规范
分支怎么起、提交信息怎么写、PR 之前自查什么。
分支
feat/<模块>-<一句话>
fix/<模块>-<问题>
docs/<主题>
chore/<杂项>
例:feat/homesettings-theme-sync、fix/integration-var-cache。
提交信息
标题一行说完「做了什么」,不加句号;正文写「为什么」,需要时补「怎么验证」。
feat(homesettings): 主题色改动即时下发到皮肤
原来要重启 Rainmeter 才生效。改成监听配置文件变化后主动刷新变量,
实测切换主题颜色后 200ms 内生效。
验证:Win10 22H2 + Rainmeter 4.5.21,切换 6 次主题色无残留旧颜色。
- 前缀从
feat / fix / docs / refactor / chore / perf / test里选一个; - 一个提交只做一件事,重构与功能分开提交;
- 中文没问题,但不要把多个无关改动塞进同一个提交。
PR 之前
-
dotnet build零警告(新增警告请说明原因) - 手动跑过一遍受影响的皮肤
- 改了配置模型的话,说明旧配置怎么迁移
- 涉及界面的改动附截图(缩放 100% 与 150% 各一张)
代码风格
- C# 跟随仓库里的
.editorconfig,不额外引入格式化工具; - XAML 属性顺序:
x:Name→ 布局 → 外观 → 事件; - 注释解释「为什么」,不复述「是什么」。