diff options
| author | doufenghu <[email protected]> | 2023-10-17 23:48:23 +0800 |
|---|---|---|
| committer | doufenghu <[email protected]> | 2023-10-17 23:48:23 +0800 |
| commit | 146b8d92fffa5b6e1cbf2f943cb79b036f5f8c7a (patch) | |
| tree | b010e8cc387a493685829668d8de7813cbf777af /docs/develop-guide.md | |
| parent | 275ea010b34ed50daaab52a5fdfd6f6ae3ead3ab (diff) | |
[Docs][develop-guide] 增加开发规范文档，描述如何撰写Git commit message
Diffstat (limited to 'docs/develop-guide.md')
| -rw-r--r-- | docs/develop-guide.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/develop-guide.md b/docs/develop-guide.md new file mode 100644 index 0000000..785cfcb --- /dev/null +++ b/docs/develop-guide.md @@ -0,0 +1,14 @@ +# Develop Guide + +## How to write a high quality Git commit message +> [purpose] [module name] [sub-module name] Description (JIRA Issue ID) +- Issue purpose: + - Fix: bug fixes + - Feature: add new feature or functionality + - Improve: Make enhancements or improvements to existing code + - Docs: changes to the documentation like README + - Test: add or modify tests +- Module name: the current issue involves the name of the module, for example: `Core`, `Common`, `Connector`, etc. +- Sub-module name: the current issue involves the name of the sub-module, for example: `ClickHouse`, `Kafka`, `IPFix`, etc. +- Description: The most important part of a commit message is that it should be clear and meaningful. +- JIRA Issue ID: Integrating JIRA is used for issue tracking. |