From 1edbb5f16ac4e7fefb0f69e31219789e2076c900 Mon Sep 17 00:00:00 2001 From: samwaf Date: Tue, 29 Sep 2026 16:10:59 +0800 Subject: [PATCH] docs: add question template and English versions of all issue templates --- .github/ISSUE_TEMPLATE/1_bug_report_en.yml | 47 +++++++++++++++++ .../ISSUE_TEMPLATE/2_feature_request_en.yml | 35 +++++++++++++ .github/ISSUE_TEMPLATE/3_compile_en.yml | 49 ++++++++++++++++++ .github/ISSUE_TEMPLATE/4_question_cn.yml | 50 +++++++++++++++++++ .github/ISSUE_TEMPLATE/5_question_en.yml | 50 +++++++++++++++++++ 5 files changed, 231 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/1_bug_report_en.yml create mode 100644 .github/ISSUE_TEMPLATE/2_feature_request_en.yml create mode 100644 .github/ISSUE_TEMPLATE/3_compile_en.yml create mode 100644 .github/ISSUE_TEMPLATE/4_question_cn.yml create mode 100644 .github/ISSUE_TEMPLATE/5_question_en.yml diff --git a/.github/ISSUE_TEMPLATE/1_bug_report_en.yml b/.github/ISSUE_TEMPLATE/1_bug_report_en.yml new file mode 100644 index 00000000..2531ba0d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1_bug_report_en.yml @@ -0,0 +1,47 @@ +name: '🐛 Bug Report' +description: 'Report a defect' +title: '[Bug] ' +labels: ['🐛 Bug'] +assignees: + - samwafgo +body: + - type: input + attributes: + label: 'Product Version' + description: The SamWaf version you are using. + validations: + required: true + + - type: checkboxes + attributes: + label: 'Edition' + options: + - label: 'Community Edition' + validations: + required: true + + - type: textarea + attributes: + label: 'Environment' + description: Please provide a clear and concise description of your environment (OS, deployment method, database, etc.). + validations: + required: true + + - type: textarea + attributes: + label: '🐛 Bug Description' + description: | + Please provide a clear and concise description of the bug. If the problem is complex, describe it in detail.
+ Vague reports may not be processed. Please provide enough detail to allow us to reproduce and fix the issue. + validations: + required: true + + - type: textarea + attributes: + label: 'Expected Behavior' + description: Please provide a clear and concise description of what you expected to happen. + + - type: textarea + attributes: + label: 'Additional Information' + description: Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/2_feature_request_en.yml b/.github/ISSUE_TEMPLATE/2_feature_request_en.yml new file mode 100644 index 00000000..879c99ee --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2_feature_request_en.yml @@ -0,0 +1,35 @@ +name: '⭐️ Feature Request' +description: 'Suggest a feature or improvement' +title: '[Feature] ' +labels: ['⭐️ Feature Request'] +assignees: + - samwafgo +body: + - type: input + attributes: + label: 'Product Version' + description: The SamWaf version you are using. + validations: + required: true + + - type: checkboxes + attributes: + label: 'Edition' + options: + - label: 'Community Edition' + validations: + required: true + + - type: textarea + attributes: + label: '⭐️ Feature Description' + description: | + Please provide a clear and concise description of the problem you want this feature to solve.
+ Vague requests may not be processed. + validations: + required: true + + - type: textarea + attributes: + label: 'Additional Information' + description: Add any other context about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/3_compile_en.yml b/.github/ISSUE_TEMPLATE/3_compile_en.yml new file mode 100644 index 00000000..aab8664b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3_compile_en.yml @@ -0,0 +1,49 @@ +name: '⭐️ Compile Issue' +description: 'Questions about building and debugging the source code' +title: '[Compile Issue] ' +labels: ['⭐️ Compile Issue'] +assignees: + - samwafgo +body: + - type: input + attributes: + label: 'Build Environment' + description: | + Please provide detailed build environment information (OS, compiler version, etc.). + validations: + required: true + + - type: checkboxes + attributes: + label: 'Issue Type' + options: + - label: 'Compile error' + - label: 'Link error' + - label: 'Runtime error' + - label: 'Performance issue' + - label: 'Other' + validations: + required: true + + - type: textarea + attributes: + label: '⭐️ Issue Description' + description: | + Please describe the build issue in detail, including error logs, reproduction steps, etc.
+ Incomplete or vague reports may not be processed effectively. + validations: + required: true + + - type: textarea + attributes: + label: 'Reproduction Steps' + description: | + Please provide a list of steps to reproduce the issue, and a minimal code example if possible. + validations: + required: true + + - type: textarea + attributes: + label: 'Additional Information' + description: | + Add any other context or relevant links here, such as solutions you have already tried. diff --git a/.github/ISSUE_TEMPLATE/4_question_cn.yml b/.github/ISSUE_TEMPLATE/4_question_cn.yml new file mode 100644 index 00000000..2525239b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/4_question_cn.yml @@ -0,0 +1,50 @@ +name: '❓ 问题咨询' +description: '使用过程中遇到问题，来这里提问（非缺陷反馈）' +title: '[Question] ' +labels: ['❓ Question'] +assignees: + - samwafgo +body: + - type: input + attributes: + label: '产品版本' + description: 你正在使用的 SamWaf 版本（如 v1.x.x）。 + validations: + required: true + + - type: checkboxes + attributes: + label: '版本类型' + options: + - label: '社区版' + validations: + required: true + + - type: checkboxes + attributes: + label: '已查阅资料' + description: 提问前请先确认已查阅相关资料。 + options: + - label: '我已查阅在线文档（https://doc.samwaf.com/）' + - label: '我已搜索历史 Issue，未找到相同问题' + validations: + required: true + + - type: textarea + attributes: + label: '❓ 问题描述' + description: | + 请提供一个清晰且简洁的问题描述，说明你想咨询的内容。
+ 请尽量提供足够的上下文（如操作步骤、相关配置、截图等），以便更快得到解答。 + validations: + required: true + + - type: textarea + attributes: + label: '环境信息' + description: 操作系统、部署方式（Docker/直接部署）、数据库类型等（可选）。 + + - type: textarea + attributes: + label: '补充信息' + description: 在这里添加关于问题的任何其他背景信息。 diff --git a/.github/ISSUE_TEMPLATE/5_question_en.yml b/.github/ISSUE_TEMPLATE/5_question_en.yml new file mode 100644 index 00000000..69bc2d74 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/5_question_en.yml @@ -0,0 +1,50 @@ +name: '❓ Question / Help' +description: 'Ask a question about using SamWaf (for bug reports, use the Bug Report template)' +title: '[Question] ' +labels: ['❓ Question'] +assignees: + - samwafgo +body: + - type: input + attributes: + label: 'Product Version' + description: The SamWaf version you are using (e.g. v1.x.x). + validations: + required: true + + - type: checkboxes + attributes: + label: 'Edition' + options: + - label: 'Community Edition' + validations: + required: true + + - type: checkboxes + attributes: + label: 'Pre-checks' + description: Please confirm the following before asking. + options: + - label: 'I have read the online documentation (https://doc.samwaf.com/)' + - label: 'I have searched existing issues and found no matching question' + validations: + required: true + + - type: textarea + attributes: + label: '❓ Question Description' + description: | + Please provide a clear and concise description of your question.
+ Include as much context as possible (steps taken, relevant configuration, screenshots, etc.) so we can answer faster. + validations: + required: true + + - type: textarea + attributes: + label: 'Environment' + description: OS, deployment method (Docker/binary), database type, etc. (optional). + + - type: textarea + attributes: + label: 'Additional Information' + description: Add any other context about the question here.