标准化 git commit message #289

z0z0r4 · 2025-02-16T00:19:49Z

z0z0r4
Feb 16, 2025
Maintainer

个人项目无所谓，但多人合作的项目应该起码最低限度地做到这点...

建议加个检查之类的，最起码改成 type(scope): message，尽量写的有信息量一点，表达不出信息量的可以压根别用英文......

随便截了一坨，不能说是杂乱无章也得是意味不明 https://github.com/PCL-Community/PCL2-CE/commits/dev/

从你提供的信息中提取出的所有 git commit message 如下：

1. revise http proxy option description (#288)
2. Merge pull request #286 from PCL-Community/fix#285
3. Fix incorrect order
4. Fix sort cost too much time
5. Feature sort
6. Fix dir not create
7. Fix mistake share webplib with official
8. 更新 README.md
9. Merge pull request #284 from PCL-Community/docs/changelog
10. Docs changelog.md: 更新 2.10.3
11. Merge pull request #281 from PCL-Community/dev
12. Slow Ring 2.10.3
13. Fix typo
14. Fix not save after remove
15. Fix potential repeat
16. Fix type error
17. Fix changelog lastversion code
18. Merge pull request #279 from PCL-Community/dev
19. 2.10.3 360 Fast Ring 跑跑先
20. Merge pull request #278 from 9223372036854775807-Studio/main
21. Fix 版本设置下的内存
22. Merge branch 'dev' of https://github.com/PCL-Community/PCL2-CE into dev
23. close #272
24. 帮助库换用官方源
25. Update README.md
26. Merge pull request #249 from PCL-Community/feat#87
27. Merge pull request #242 from JustQiyi/main
28. Merge branch 'main' into main
29. 中英文符号与中英文之间的空格问题
30. 异步执行以解决阻塞问题
31. Merge pull request #271 from PCL-Community/Fix#266
32. 一些细节
33. Fix are u sure about that????

这些是从你提供的文本中提取出的所有 commit message。

z0z0r4 · 2025-02-16T00:26:41Z

z0z0r4
Feb 16, 2025
Maintainer Author

Deepseek Generated

在开源项目中，保证 commit 规范是非常重要的，它有助于提高代码的可读性、可维护性，并方便协作开发。以下是一些常见的实践和工具，用于确保 commit 规范：

1. 制定 Commit Message 规范
使用统一的 commit message 格式，例如 Conventional Commits。
常见的格式：
<type>(<scope>): <subject>
<空行>
<body>
<空行>
<footer>
type：提交的类型，例如 feat（新功能）、fix（修复 bug）、docs（文档更新）、style（代码样式调整）、refactor（重构）、test（测试）、chore（构建或辅助工具变动）等。

scope（可选）：影响的模块或范围。

subject：简短的描述。

body（可选）：详细的描述。

footer（可选）：例如关联的 issue 或 breaking changes。
示例：
feat(user): add login functionality

- Add login API endpoint
- Implement JWT authentication

Closes #123
2. 使用工具自动化检查

Commitlint：用于检查 commit message 是否符合规范。

安装并配置 commitlint。

结合 Husky 在提交时自动检查 commit message。

Husky：Git 钩子工具，可以在 commit 或 push 时触发检查。

示例：在 .husky/commit-msg 中添加 commitlint 检查。

Commitizen：交互式工具，帮助开发者生成符合规范的 commit message。

安装并配置 Commitizen。

3. 代码审查（Code Review）

在合并请求（Pull Request）时，要求 reviewer 检查 commit message 是否符合规范。

使用 GitHub、GitLab 等平台的代码审查功能，确保每个 commit 都清晰、有意义。

4. 提供贡献指南（Contributing Guide）

在项目的 CONTRIBUTING.md 或 README.md 中明确写出 commit message 的规范。

提供示例和工具的使用说明，帮助新贡献者快速上手。

5. 使用 Git 钩子（Git Hooks）

在 .git/hooks 中配置钩子脚本，例如 pre-commit 或 commit-msg，用于自动化检查。

示例：使用 commit-msg 钩子检查 commit message 是否符合规范。

6. Changelog 生成

使用工具（如 standard-version 或 semantic-release）根据 commit message 自动生成 changelog。

确保每次发布版本时，changelog 都能清晰地反映变更内容。

7. 培训和文档

为新贡献者提供培训或文档，解释 commit 规范的重要性以及如何编写符合规范的 commit message。

在项目中提供示例 commit message。

8. 持续集成（CI）检查

在 CI 流程中加入 commit message 检查。

示例：在 GitHub Actions 或 GitLab CI 中配置 commitlint 检查。

9. 使用 Issue 跟踪

将 commit 与 issue 关联，例如在 commit message 中添加 Closes #123 或 Fixes #123。

使用 GitHub/GitLab 的关键字自动关闭 issue。

10. 定期审查和优化

定期审查 commit 规范是否合理，是否需要根据项目发展进行调整。

收集贡献者的反馈，优化规范和工具。

通过以上方法，开源项目可以有效地保证 commit 规范，从而提高代码质量和协作效率。

0 replies

allMagicNB · 2025-02-16T00:27:03Z

allMagicNB
Feb 16, 2025
Maintainer

这些是从你提供的文本中提取出的所有 commit message。

🤔

1 reply

z0z0r4 Feb 16, 2025
Maintainer Author

Deepseek Generated

Deep-Dark-Forest · 2025-02-16T01:00:28Z

Deep-Dark-Forest
Feb 16, 2025
Maintainer

社区已经投票过了，决定使用 angular

3 replies

z0z0r4 Feb 16, 2025
Maintainer Author

抱歉我没看到有 discussion，还没实装吗？没在 repo 找到相关 git hook 之类的

wuliaodexiaoluo Feb 16, 2025
Maintainer

抱歉我没看到有 discussion，还没实装吗？没在 repo 找到相关 git hook 之类的

实际上在群里投票了，但是不知道结果如何

标准化 git commit message #289

Uh oh!

Uh oh!

z0z0r4 Feb 16, 2025 Maintainer

Replies: 3 comments · 4 replies

Uh oh!

z0z0r4 Feb 16, 2025 Maintainer Author

1. 制定 Commit Message 规范

2. 使用工具自动化检查

3. 代码审查（Code Review）

4. 提供贡献指南（Contributing Guide）

5. 使用 Git 钩子（Git Hooks）

6. Changelog 生成

7. 培训和文档

8. 持续集成（CI）检查

9. 使用 Issue 跟踪

10. 定期审查和优化

Uh oh!

allMagicNB Feb 16, 2025 Maintainer

Uh oh!

z0z0r4 Feb 16, 2025 Maintainer Author

Uh oh!

Deep-Dark-Forest Feb 16, 2025 Maintainer

Uh oh!

z0z0r4 Feb 16, 2025 Maintainer Author

Uh oh!

wuliaodexiaoluo Feb 16, 2025 Maintainer

Uh oh!

Deep-Dark-Forest Feb 16, 2025 Maintainer

z0z0r4
Feb 16, 2025
Maintainer

Replies: 3 comments 4 replies

z0z0r4
Feb 16, 2025
Maintainer Author

allMagicNB
Feb 16, 2025
Maintainer

z0z0r4 Feb 16, 2025
Maintainer Author

Deep-Dark-Forest
Feb 16, 2025
Maintainer

z0z0r4 Feb 16, 2025
Maintainer Author

wuliaodexiaoluo Feb 16, 2025
Maintainer

Deep-Dark-Forest Feb 16, 2025
Maintainer