From 6b13b2e84f54810834713ee89b5ba3a98c9ef771 Mon Sep 17 00:00:00 2001 From: ZacharyZcR Date: Sat, 20 Dec 2025 10:28:09 +0800 Subject: [PATCH] =?UTF-8?q?feat:=20=E6=B7=BB=E5=8A=A0=20GitHub=20Issue=20?= =?UTF-8?q?=E6=A8=A1=E6=9D=BF?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - bug_report.yml: Bug 报告模板 - feature_request.yml: 功能请求模板 - plugin_request.yml: 新插件/协议支持请求模板 - false_positive.yml: 误报/漏报报告模板 - config.yml: 禁用空白 issue,添加文档链接 --- .github/ISSUE_TEMPLATE/bug_report.yml | 90 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 11 +++ .github/ISSUE_TEMPLATE/false_positive.yml | 94 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 74 +++++++++++++++++ .github/ISSUE_TEMPLATE/plugin_request.yml | 86 ++++++++++++++++++++ 5 files changed, 355 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/false_positive.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/plugin_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..9924669 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,90 @@ +name: 🐛 Bug 报告 +description: 报告扫描异常、崩溃或错误行为 +title: "[Bug] " +labels: ["bug"] + +body: + - type: markdown + attributes: + value: | + 感谢您提交 Bug 报告!请尽可能详细地填写以下信息,这将帮助我们更快定位和修复问题。 + + - type: dropdown + id: module + attributes: + label: 问题模块 + description: 问题出现在哪个功能模块? + options: + - 端口扫描 (Port Scan) + - 主机存活检测 (Host Discovery) + - 服务识别 (Service Detection) + - 弱口令爆破 (Brute Force) + - POC/漏洞扫描 (POC Scan) + - Web指纹识别 (Web Fingerprint) + - 输出/日志 (Output/Logging) + - 命令行参数 (CLI Arguments) + - 其他 (Other) + validations: + required: true + + - type: dropdown + id: severity + attributes: + label: 严重程度 + options: + - 崩溃/无法使用 (Crash) + - 功能异常 (Malfunction) + - 结果不准确 (Inaccurate) + - 性能问题 (Performance) + - 其他 (Other) + validations: + required: true + + - type: textarea + id: description + attributes: + label: 问题描述 + description: 清晰描述遇到的问题 + placeholder: | + 发生了什么? + 预期的行为是什么? + validations: + required: true + + - type: textarea + id: reproduce + attributes: + label: 复现步骤 + description: 提供可以复现问题的命令或步骤 + placeholder: | + 1. 执行命令: fscan -h xxx -p xxx + 2. 观察到... + render: shell + validations: + required: true + + - type: textarea + id: output + attributes: + label: 错误输出 + description: 粘贴相关的错误信息或日志(请脱敏敏感信息) + render: shell + + - type: textarea + id: environment + attributes: + label: 环境信息 + description: 请提供运行环境信息 + value: | + - fscan 版本: [如 1.8.4] + - 操作系统: [如 Windows 11 / Ubuntu 22.04 / macOS 14] + - 架构: [如 amd64 / arm64] + - Go 版本 (如自编译): [如 go1.20.10] + validations: + required: true + + - type: textarea + id: additional + attributes: + label: 补充信息 + description: 其他可能有助于排查问题的信息 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..6472364 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +# Issue 模板配置 +# 禁止空白 issue,强制用户选择模板 +blank_issues_enabled: false + +contact_links: + - name: 📖 使用文档 + url: https://github.com/shadow1ng/fscan/blob/main/README.md + about: 提交 Issue 前请先查阅文档 + - name: 💬 讨论区 + url: https://github.com/shadow1ng/fscan/discussions + about: 一般性问题和讨论请使用 Discussions diff --git a/.github/ISSUE_TEMPLATE/false_positive.yml b/.github/ISSUE_TEMPLATE/false_positive.yml new file mode 100644 index 0000000..0fad848 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/false_positive.yml @@ -0,0 +1,94 @@ +name: 🎯 误报/漏报 +description: 报告扫描结果不准确的问题 +title: "[Accuracy] " +labels: ["accuracy"] + +body: + - type: markdown + attributes: + value: | + 感谢您帮助提高 fscan 的准确性!误报和漏报都是需要优化的问题。 + + - type: dropdown + id: type + attributes: + label: 问题类型 + options: + - 误报 (False Positive) - 报告了不存在的问题 + - 漏报 (False Negative) - 未能检测到存在的问题 + validations: + required: true + + - type: dropdown + id: category + attributes: + label: 涉及功能 + options: + - 主机存活检测 + - 端口状态判断 + - 服务识别 + - 弱口令检测 + - POC/漏洞检测 + - Web指纹识别 + - 其他 + validations: + required: true + + - type: textarea + id: fscan-output + attributes: + label: fscan 输出结果 + description: 粘贴相关的扫描输出(请脱敏敏感信息如真实IP、密码等) + render: shell + validations: + required: true + + - type: textarea + id: actual + attributes: + label: 实际情况 + description: 描述目标的真实状态 + placeholder: | + 实际上这个端口是关闭的 / 服务版本是 xxx / 密码不是 xxx... + 验证方式: 通过 nmap/手动连接/其他工具 确认... + validations: + required: true + + - type: textarea + id: environment + attributes: + label: 目标环境 + description: 描述目标的环境信息(请脱敏) + placeholder: | + - 目标系统: Windows Server 2019 / Ubuntu 22.04 + - 服务版本: MySQL 8.0 / Redis 7.0 + - 网络环境: 直连 / 通过代理 / VPN + validations: + required: true + + - type: textarea + id: command + attributes: + label: 使用的命令 + description: 执行的 fscan 命令 + placeholder: "fscan -h x.x.x.x -p 1-65535 -pwdf pass.txt" + render: shell + validations: + required: true + + - type: input + id: version + attributes: + label: fscan 版本 + placeholder: "如: 1.8.4" + validations: + required: true + + - type: textarea + id: suggestion + attributes: + label: 改进建议 + description: 如果您有改进的想法,请分享 + placeholder: | + 建议增加 xxx 判断条件... + 或者调整 xxx 检测逻辑... diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..c60d529 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,74 @@ +name: ✨ 功能请求 +description: 提议新功能或改进现有功能 +title: "[Feature] " +labels: ["enhancement"] + +body: + - type: markdown + attributes: + value: | + 感谢您的功能建议!请详细描述您的需求,这将帮助我们评估和实现。 + + - type: dropdown + id: category + attributes: + label: 功能类别 + options: + - 新扫描能力 (New Scan Capability) + - 性能优化 (Performance) + - 用户体验 (UX/CLI) + - 输出格式 (Output Format) + - 配置选项 (Configuration) + - 集成/API (Integration/API) + - 其他 (Other) + validations: + required: true + + - type: textarea + id: problem + attributes: + label: 解决什么问题? + description: 描述您遇到的痛点或使用场景 + placeholder: | + 在进行 xxx 操作时,我希望能够... + 目前的问题是... + validations: + required: true + + - type: textarea + id: solution + attributes: + label: 期望的解决方案 + description: 描述您希望的功能或行为 + placeholder: | + 希望能够通过 -xxx 参数来... + 或者增加一个新的模块来... + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: 替代方案 + description: 您考虑过的其他解决方案或变通方法 + placeholder: | + 目前我通过 xxx 方式来解决,但是... + + - type: dropdown + id: priority + attributes: + label: 优先级建议 + description: 您认为这个功能的重要程度 + options: + - 高 - 核心功能缺失 + - 中 - 明显改善体验 + - 低 - 锦上添花 + validations: + required: true + + - type: checkboxes + id: contribution + attributes: + label: 贡献意愿 + options: + - label: 我愿意尝试实现这个功能并提交 PR diff --git a/.github/ISSUE_TEMPLATE/plugin_request.yml b/.github/ISSUE_TEMPLATE/plugin_request.yml new file mode 100644 index 0000000..f44bb94 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/plugin_request.yml @@ -0,0 +1,86 @@ +name: 🔌 新插件/协议支持 +description: 请求支持新的服务、协议或漏洞检测 +title: "[Plugin] " +labels: ["plugin", "enhancement"] + +body: + - type: markdown + attributes: + value: | + 感谢您的插件请求!fscan 持续扩展对各种服务和协议的支持。 + + - type: dropdown + id: type + attributes: + label: 请求类型 + options: + - 新服务/协议支持 (New Service) + - 新弱口令检测 (New Brute Force) + - 新漏洞 POC (New POC) + - 新指纹识别 (New Fingerprint) + validations: + required: true + + - type: input + id: service + attributes: + label: 服务/协议名称 + placeholder: "如: Kafka, ClickHouse, etcd, Consul" + validations: + required: true + + - type: input + id: port + attributes: + label: 默认端口 + placeholder: "如: 9092, 8123, 2379" + + - type: textarea + id: description + attributes: + label: 服务描述 + description: 简要介绍这个服务/协议 + placeholder: | + 这是一个用于 xxx 的服务... + 在内网环境中常见于... + validations: + required: true + + - type: textarea + id: detection + attributes: + label: 识别方法 + description: 如何识别/检测这个服务(如有了解) + placeholder: | + Banner 特征: xxx + 默认响应: xxx + 认证方式: xxx + + - type: textarea + id: reference + attributes: + label: 参考资料 + description: 相关文档、其他工具实现、漏洞详情等 + placeholder: | + - 官方文档: https://... + - 其他工具实现: https://... + - CVE编号: CVE-xxxx-xxxx + + - type: dropdown + id: prevalence + attributes: + label: 使用普遍程度 + description: 这个服务在目标环境中的常见程度 + options: + - 非常常见 (企业环境标配) + - 较为常见 (经常遇到) + - 偶尔遇到 + - 较少见但重要 + + - type: checkboxes + id: contribution + attributes: + label: 贡献意愿 + options: + - label: 我愿意尝试实现这个插件并提交 PR + - label: 我可以提供测试环境