Merge pull request #177 from ByConity/WillemJiang-patch-1

Update PULL_REQUEST_TEMPLATE.md

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,6 +1,13 @@
-I hereby agree to the terms of the CLA available at: [placeholder]
+<!---
+A technical comment, you are free to remove or leave it as it is when PR is created
+The following categories are used in the next scripts, update them accordingly
+utils/changelog/changelog.py
+tests/ci/run_check.py
+-->
 
-Changelog category (leave one):
+<!-- If you are doing this for the first time, it's recommended to read the lightweight Contributing to ByConity Documentation https://github.com/ByConity/ByConity/blob/master/CONTRIBUTING.md guide first. -->
+
+### Changelog category <!-- please remove the below items and leave one that you choose -->:
 - New Feature
 - Bug Fix
 - Improvement
@@ -12,15 +19,23 @@ Changelog category (leave one):
 - Not for changelog (changelog entry is not required)
 
 
-Changelog entry (a user-readable short description of the changes that goes to CHANGELOG.md):
+### Changelog entry (a user-readable short description of the changes that goes to CHANGELOG.md):
 
 ...
 
+### Documentation entry for user-facing changes
 
-Detailed description / Documentation draft:
+- [ ] Documentation is written (mandatory for new features)
 
-...
+<!---
+
+Add a user-readable short description of the changes that should be added to https://github.com/ByConity/byconity.github.io below.
+
+At a minimum, the following information should be added (but add more as needed).
 
+- Motivation: Why is this function, table engine, etc. useful to ByConity users?
 
-If you are doing this for the first time, it's recommended to read the lightweight [Contributing to ByConity Documentation](https://github.com/ByConity/ByConity/blob/master/CONTRIBUTING.md) guide first.
+- Parameters: If the feature being added takes arguments, options or is influenced by settings, please list them below with a brief explanation.
 
+- Example use: A query or command.
+-->