diff options
Diffstat (limited to 'docs/develop-guide.md')
| -rw-r--r-- | docs/develop-guide.md | 22 |
1 files changed, 12 insertions, 10 deletions
diff --git a/docs/develop-guide.md b/docs/develop-guide.md index 785cfcb..5c55d47 100644 --- a/docs/develop-guide.md +++ b/docs/develop-guide.md @@ -1,14 +1,16 @@ # 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. +> - 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. + |