diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml deleted file mode 100644 index f77fc032f5..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ /dev/null @@ -1,39 +0,0 @@ -name: Bug Report -description: File a bug report -title: "[Bug]: " -labels: [ "bug" ] -body: - - type: markdown - attributes: - value: | - Thanks for taking the time to fill out this bug report! - - type: textarea - id: description - attributes: - label: What happened? - description: Also tell us, what did you expect to happen? - placeholder: Tell us what you see! - value: "A bug happened!" - validations: - required: true - - type: input - id: version - attributes: - label: Version - description: What version of our software are you running? - validations: - required: true - - type: input - id: contact - attributes: - label: Contact Details - description: How can we get in touch with you if we need more info? - placeholder: ex. email@example.com - validations: - required: false - - type: textarea - id: logs - attributes: - label: Relevant log output - description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. - render: Shell diff --git a/.github/ISSUE_TEMPLATE/issue_report.md b/.github/ISSUE_TEMPLATE/issue_report.md new file mode 100644 index 0000000000..695cfc31d7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue_report.md @@ -0,0 +1,102 @@ +# Issue Report + +## 1.Submission Guidelines +```shell +[type][module] +``` +## 2.Guidelines Description +### 2.1 Description of Guidelines + * type:Operation type, written in all lowercase + * module:Modified module, written in all lowercase + * description:Problem description, written with the first letter capitalized + * If a single commit involves multiple modules, use the module with the most modifications as the final module + * For commits related to proto interfaces, be sure to submit them separately + * In principle, one commit should solve one problem; each submission should involve no more than 100 files + + ### 2.2 Parameter Description + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Parameter TypeParameter RangeParameter Description
typefeatNew feature, meaning the implementation of new requirements.
fixFix, addressing a bug.
docDocumentation, adding or updating documentation.
styleStyle adjustment, primarily for code style-related submissions, such as formatting.
refactorRefactoring code, restructuring existing functionality.
testUnit test, adding code related to unit tests.
choreIntegration and deployment related tasks.
modulecoordinatorMetadata management related.
storeDistributed storage-related, such as RocksDB, Raft-KV-Engine.
sdkClient interfaces.
deployDeployment script related.
commonBasic modules, such as CMake restructuring.
protopProto-related Protobuf modifications.
indexIndex-related, involving scalar and vector indexing.
executorExecutor layer-related.
rulesProduct specifications related.
descriptionDescription of the modifications in this commit, requirements: 1) All in English; 2) First letter capitalized
+ +*Example:* +```shell +[feat][coordinator] Add interface to metadata. +``` +## 3. Submission Conditions + * Ensure that all integration tests pass in advance. +