在 Github 上 Fork 了一个项目进行修改后，需要遵循一定的规范来记录这些修改。以下是 AI 建议的一些规范和示例。
为项目添加原项目信息
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
| # 项目名称
## 📌 关于本项目
本项目是基于 [recarto404/WxDatDecrypt](https://github.com/recarto404/WxDatDecrypt) 的个人维护版本。
**原项目**: https://github.com/recarto404/WxDatDecrypt
**原作者**: recarto404
**原项目许可证**: MIT License
### 与原项目的关系
- 本项目保持与上游项目同步更新
- 在原项目基础上进行了 [个人定制/bug修复/功能增强等]
- 遵循原项目的开源许可证条款
### 贡献
如果您的改进适用于所有用户,建议直接向[原项目](https://github.com/recarto404/WxDatDecrypt)提交 Pull Request。
---
## 功能介绍
...
## 许可证
MIT License
Copyright (c) [年份] [原作者名]
本项目的修改部分同样采用 MIT License 开源。
完整许可证内容请查看 [LICENSE](LICENSE) 文件。
|
Git commit message 有多种规范,这里介绍最流行的 Conventional Commits 规范:
基本格式
1
2
3
4
5
| <type>(<scope>): <subject>
<body>
<footer>
|
Type 类型(必需)
1
2
3
4
5
6
7
8
9
10
11
| feat: 新功能
fix: bug 修复
docs: 文档修改
style: 代码格式修改(不影响代码运行)
refactor: 重构(既不是新功能也不是修复bug)
perf: 性能优化
test: 测试相关
chore: 构建过程或辅助工具的变动
ci: CI/CD 相关
build: 构建系统或外部依赖变更
revert: 回滚之前的提交
|
实际例子
简单提交
1
2
3
4
5
6
7
8
| git commit -m "feat: 添加微信图片解密功能"
git commit -m "fix: 修复文件路径错误导致的崩溃"
git commit -m "docs: 更新 README 安装说明"
git commit -m "style: 统一代码缩进格式"
git commit -m "refactor: 重构解密算法逻辑"
git commit -m "perf: 优化大文件处理性能"
git commit -m "test: 添加解密功能单元测试"
git commit -m "chore: 更新依赖包版本"
|
带 scope(范围)
1
2
3
| git commit -m "feat(decoder): 支持新的加密算法"
git commit -m "fix(ui): 修复按钮点击无响应问题"
git commit -m "docs(api): 添加 API 使用文档"
|
详细提交(多行)
1
2
3
4
5
6
7
| git commit -m "feat: 添加批量解密功能
- 支持选择文件夹批量处理
- 添加进度条显示
- 支持中断和继续
Closes #123"
|
同步上游更新的标记
当你从 upstream 同步代码时:
1
2
3
4
5
6
7
8
9
10
11
12
13
|
git commit -m "chore: 同步上游更新至 v2.1.0"
git commit -m "chore: 合并上游最新更新
- 更新至 upstream commit abc1234
- 包含新功能 XYZ
- 修复了已知 bug"
git merge upstream/main
|
特殊标记
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
|
git commit -m "feat!: 重构 API 接口
BREAKING CHANGE: API 路径从 /v1 改为 /v2"
git commit -m "fix: 修复内存泄漏问题
Fixes #456"
Closes
git commit -m "feat: 添加新功能
Co-authored-by: 张三 <zhangsan@example.com>"
|
实用建议
- 保持简洁: 首行不超过 50 字符
- 使用祈使语气: “添加功能” 而不是 “添加了功能”
- 说明为什么: body 部分解释为什么做这个改动
- 一次提交做一件事: 不要把多个不相关的改动放在一起
- 中文或英文统一: 团队内保持一致
快速参考
1
2
3
4
5
6
|
git commit -m "feat: 新功能描述"
git commit -m "fix: bug修复描述"
git commit -m "docs: 文档更新"
git commit -m "chore: 同步上游更新"
git commit -m "refactor: 代码重构"
|
针对前面添加项目来源和许可证声明到 README 的修改,可以这样写:
推荐写法
简洁版(推荐)
1
| git commit -m "docs: 添加原项目来源和许可证声明"
|
详细版
1
2
3
4
5
6
| git commit -m "docs: 添加原项目来源和许可证声明
- 注明项目基于 recarto404/WxDatDecrypt
- 添加原作者和原项目链接
- 说明 MIT License 继承关系
- 补充项目关系和贡献指引"
|
如果是初次创建 README
1
| git commit -m "docs: 创建 README 并注明项目来源"
|
如果只是更新现有 README
1
| git commit -m "docs: 更新 README 添加来源声明"
|
为什么用 docs?
- ✅
docs: 文档相关的修改(README、注释、文档文件等)
- ❌ 不用
feat: 这不是新功能
- ❌ 不用
chore: 这不是构建/工具相关
