标准提交消息格式

一个标准的提交消息应包括三部分：标题（summary）、正文（description）和脚注（footer）。

1. 标题（Summary）

• 简洁明了，不超过50个字符。
• 使用祈使句，如 “Add feature” 或 “Fix bug”。
• 首字母大写，不使用句号。

2. 正文（Description）

• 详细描述变更内容，解释为什么需要这些变更。
• 每行不超过72个字符。
• 标题和正文之间空一行。

3. 脚注（Footer）

• 用于关联issue，或添加其他元信息。
• 如 “Fixes #123” 或 “See also #456”。

各阶段的提交消息写法

初始阶段

初始阶段包括项目的初始化和设置基本结构。

1. 初始提交

Initial commitSet up the initial project structure with basic files.

2. 添加基本文件

Add README, LICENSE, and .gitignoreInclude initial documentation and licensing information.
Add .gitignore to exclude build artifacts and temporary files.

3. 设置基础目录

Set up basic directory structureCreate directories for source code, tests, and documentation.

开发阶段

开发阶段包括添加新功能、修复错误、优化性能和添加文档等。

1. 添加新功能

Add PPM encoder moduleImplement the basic functionality for the PPM encoder module.
The encoder converts serial input to parallel output for visible light communication.
Includes unit tests for the encoder.

2. 修复错误

Fix state transition bug in PPM decoderCorrect the logic in the state machine to handle edge cases.
Fixes issue where the decoder would not properly reset.

3. 优化代码

Optimize signal processing algorithmImprove the performance of the signal processing algorithm in the PPM decoder.
Reduce the computational complexity and memory usage.

4. 添加文档

Add usage documentation for PPM encoderInclude detailed usage instructions and examples for the PPM encoder module.
Update README with a new section on module usage.

5. 重构代码

Refactor decoder logic for better readabilityClean up and reorganize the PPM decoder code to improve readability and maintainability.
No functional changes.

维护阶段

维护阶段包括修复安全漏洞、更新依赖、重构代码和改进文档等。

1. 修复安全漏洞

Fix security issue in data handlingAddress a potential buffer overflow vulnerability in the data handling logic.
Add bounds checking to prevent out-of-bounds memory access.

2. 更新依赖

Update FPGA toolchain to latest versionUpgrade the FPGA development toolchain to the latest version.
Ensure compatibility with new features and bug fixes in the toolchain.

3. 改进文档

Improve documentation for installation and setupExpand the installation guide with detailed steps for setting up the development environment.
Include troubleshooting tips and common issues.

4. 优化和性能改进

Improve performance of PPM encoderOptimize the timing and resource usage of the PPM encoder module.
Reduce latency and improve overall throughput.

总结

在每个项目阶段，编写清晰、规范的提交消息是项目维护和协作的重要部分。遵循以下标准写法，可以提高提交消息的可读性和可维护性：

• 初始阶段：聚焦于设置项目基础结构和添加基本文件。
• 开发阶段：详细描述新功能的添加、错误修复、优化和文档改进。
• 维护阶段：确保安全修复、依赖更新、文档改进和性能优化的提交消息清晰准确。

通过保持一致的提交消息格式，团队成员可以更容易地理解变更内容，追踪问题，协作开发和维护项目。