From 7e14fb092b0cd6fada3c4191a5638ae40d270753 Mon Sep 17 00:00:00 2001 From: Dwi Siswanto Date: Tue, 1 Oct 2024 15:55:02 +0700 Subject: [PATCH] chore: migrate issue templates to issue forms (#10853) * chore: migrate issue templates to issue forms Signed-off-by: Dwi Siswanto * chore: remove feature_request issue template Signed-off-by: Dwi Siswanto * chore: rm issue-report issue template Signed-off-by: Dwi Siswanto * chore: make env attrs as optional in false-{positive,negative} issue templates Signed-off-by: Dwi Siswanto * chore: update labels for template-{contribution,requests} Signed-off-by: Dwi Siswanto --------- Signed-off-by: Dwi Siswanto --- .github/ISSUE_TEMPLATE/false-negative.md | 21 ------ .github/ISSUE_TEMPLATE/false-negative.yml | 67 +++++++++++++++++++ .github/ISSUE_TEMPLATE/false-positive.md | 24 ------- .github/ISSUE_TEMPLATE/false-positive.yml | 67 +++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 18 ----- .github/ISSUE_TEMPLATE/issue-report.md | 21 ------ .github/ISSUE_TEMPLATE/new-template.md | 17 ----- .github/ISSUE_TEMPLATE/submit-template.md | 23 ------- .../ISSUE_TEMPLATE/template-contribution.yml | 38 +++++++++++ .github/ISSUE_TEMPLATE/template-requests.yml | 40 +++++++++++ 10 files changed, 212 insertions(+), 124 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/false-negative.md create mode 100644 .github/ISSUE_TEMPLATE/false-negative.yml delete mode 100644 .github/ISSUE_TEMPLATE/false-positive.md create mode 100644 .github/ISSUE_TEMPLATE/false-positive.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 .github/ISSUE_TEMPLATE/issue-report.md delete mode 100644 .github/ISSUE_TEMPLATE/new-template.md delete mode 100644 .github/ISSUE_TEMPLATE/submit-template.md create mode 100644 .github/ISSUE_TEMPLATE/template-contribution.yml create mode 100644 .github/ISSUE_TEMPLATE/template-requests.yml diff --git a/.github/ISSUE_TEMPLATE/false-negative.md b/.github/ISSUE_TEMPLATE/false-negative.md deleted file mode 100644 index 58b67a411a9..00000000000 --- a/.github/ISSUE_TEMPLATE/false-negative.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -name: False Negative -about: 'Issue for template missing valid/expected result.' -labels: 'false-negative' - ---- - - - -### Nuclei Version: - - - -### Template file: - - - -### Command to reproduce: - - - \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/false-negative.yml b/.github/ISSUE_TEMPLATE/false-negative.yml new file mode 100644 index 00000000000..89727baaeb8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/false-negative.yml @@ -0,0 +1,67 @@ +name: False Negative +description: Report templates with false negative results. +title: "[FALSE-NEGATIVE] ..." +labels: ["false-negative"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this false-negative report! + + :warning: **Issues missing important information may be closed without further investigation.** + - type: textarea + attributes: + label: Template IDs or paths + description: | + Examples: + - CVE-202A-YYYYY + - CVE-202B-YYYYY + - http/cves/CVE-202C-YYYYY.yaml + value: | + - ... + render: markdown + validations: + required: true + - type: textarea + attributes: + label: Environment + description: | + Examples: + - **OS**: Ubuntu 20.04 + - **Nuclei** (`nuclei -version`): v3.3.3 + - **Go** (`go version`): go1.22.0 _(only if you've installed it via `go install` command)_ + value: | + - OS: + - Nuclei: + - Go: + render: markdown + validations: + required: false + - type: textarea + attributes: + label: Steps To Reproduce + description: | + Steps to reproduce the behavior, for example, commands to run the templates with Nuclei. + + :warning: **Please redact any literal target hosts/URLs or other sensitive information.** + placeholder: | + 1. Run `nuclei -t ...` + validations: + required: true + - type: textarea + attributes: + label: Relevant dumped responses + description: | + Please copy and paste any relevant dumped responses (`-dresp`/`-debug-resp`). This will be automatically formatted into code, so no need for backticks. + + :warning: **Please redact any literal target hosts/URLs or other sensitive information.** + render: shell + - type: textarea + attributes: + label: Anything else? + description: | + Links? References? Trace (`-tlog`/`-trace-log`) or error (`-elog`/`-error-log`) log? Anything that will give us more context about the issue you are encountering! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/false-positive.md b/.github/ISSUE_TEMPLATE/false-positive.md deleted file mode 100644 index ac35b814e10..00000000000 --- a/.github/ISSUE_TEMPLATE/false-positive.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: False Positive -about: 'Issue for template producing invalid/unexpected result.' -labels: 'false-positive' - ---- - - - -### Nuclei Version: - - - -### Template file: - - - -### Command to reproduce: - - - - -### Anything else: - \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/false-positive.yml b/.github/ISSUE_TEMPLATE/false-positive.yml new file mode 100644 index 00000000000..6911724ee11 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/false-positive.yml @@ -0,0 +1,67 @@ +name: False Positive +description: Report templates with false positive results. +title: "[FALSE-POSITIVE] ..." +labels: ["false-positive"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this false-positive report! + + :warning: **Issues missing important information may be closed without further investigation.** + - type: textarea + attributes: + label: Template IDs or paths + description: | + Examples: + - CVE-202A-YYYYY + - CVE-202B-YYYYY + - http/cves/CVE-202C-YYYYY.yaml + value: | + - ... + render: markdown + validations: + required: true + - type: textarea + attributes: + label: Environment + description: | + Examples: + - **OS**: Ubuntu 20.04 + - **Nuclei** (`nuclei -version`): v3.3.3 + - **Go** (`go version`): go1.22.0 _(only if you've installed it via `go install` command)_ + value: | + - OS: + - Nuclei: + - Go: + render: markdown + validations: + required: false + - type: textarea + attributes: + label: Steps To Reproduce + description: | + Steps to reproduce the behavior, for example, commands to run the templates with Nuclei. + + :warning: **Please redact any literal target hosts/URLs or other sensitive information.** + placeholder: | + 1. Run `nuclei -t ...` + validations: + required: true + - type: textarea + attributes: + label: Relevant dumped responses + description: | + Please copy and paste any relevant dumped responses (`-dresp`/`-debug-resp`). This will be automatically formatted into code, so no need for backticks. + + :warning: **Please redact any literal target hosts/URLs or other sensitive information.** + render: shell + - type: textarea + attributes: + label: Anything else? + description: | + Links? References? Trace (`-tlog`/`-trace-log`) or error (`-elog`/`-error-log`) log? Anything that will give us more context about the issue you are encountering! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index cb6be4c6be0..00000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -name: Feature request -about: Request feature to implement in this project -labels: 'Type: Enhancement' ---- - - - -### Please describe your feature request: - - -### Describe the use case of this feature: - diff --git a/.github/ISSUE_TEMPLATE/issue-report.md b/.github/ISSUE_TEMPLATE/issue-report.md deleted file mode 100644 index c6f6f07f538..00000000000 --- a/.github/ISSUE_TEMPLATE/issue-report.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -name: Issue report -about: "Issue to report invalid template" -labels: 'Type: Bug' - ---- - - - - - -### Issue description: - - - -### Anything else: - \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/new-template.md b/.github/ISSUE_TEMPLATE/new-template.md deleted file mode 100644 index 428b440e809..00000000000 --- a/.github/ISSUE_TEMPLATE/new-template.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: Template Request -about: 'request for new template to be created.' -labels: 'new-template' - ---- - - - - -### Template for? - - - -### Details: - - \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/submit-template.md b/.github/ISSUE_TEMPLATE/submit-template.md deleted file mode 100644 index b7aa1c4938f..00000000000 --- a/.github/ISSUE_TEMPLATE/submit-template.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -name: Template Contribution -about: Contributing nuclei template using GitHub Issue -labels: 'nuclei-template' ---- - -### Template Information: - - - - - -### Nuclei Template: - - - - -```yaml - -``` - - - \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/template-contribution.yml b/.github/ISSUE_TEMPLATE/template-contribution.yml new file mode 100644 index 00000000000..5d821da6e29 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/template-contribution.yml @@ -0,0 +1,38 @@ +name: Template Contribution +description: Contributing Nuclei template. +title: "[TEMPLATE CONTRIBUTION] ..." +labels: ["template-contribution"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to contribute a Nuclei template! + + :warning: **Please submit only one template per issue. This helps us manage and review contributions more effectively.** + - type: checkboxes + attributes: + label: Is there an existing template for this? + description: Please search to see if an template or issue already exists for the template you contributed. + options: + - label: I have searched the existing templates. + required: true + - type: textarea + attributes: + label: Nuclei Template + description: Please copy and paste the Nuclei template below. This will be automatically formatted into code, so no need for backticks. + render: yaml + - type: textarea + attributes: + label: Relevant dumped responses + description: | + Please copy and paste any relevant dumped responses (`-dresp`/`-debug-resp`). This will be automatically formatted into code, so no need for backticks. + + :warning: **Please redact any literal target hosts/URLs or other sensitive information.** + render: shell + - type: textarea + attributes: + label: Anything else? + description: | + Links? References? Anything that can speed up the review or validation process. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/template-requests.yml b/.github/ISSUE_TEMPLATE/template-requests.yml new file mode 100644 index 00000000000..f5b60a67317 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/template-requests.yml @@ -0,0 +1,40 @@ +name: Template Requests +description: Requesting new Nuclei templates. +title: "[TEMPLATE REQUEST] ..." +labels: ["template-requests"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this template request issue! + - type: checkboxes + attributes: + label: Is there an existing template for this? + description: Please search to see if an template or issue already exists for the template you contributed. + options: + - label: I have searched the existing templates. + required: true + - type: textarea + attributes: + label: Template requests + description: | + Examples: + - CVE-202A-YYYYY + - CVE-202B-YYYYY + - Exploit X + - Misconfiguration X + - Technology X Detection + value: | + - ... + - type: textarea + attributes: + label: Anything else? + description: | + Links? References (e.g. PoC, exploit, blog post, etc.)? Anything that can speed up template creation, such as: + - Detailed vulnerability descriptions + - Sample payloads or exploit code + - Expected responses or indicators of successful exploitation + - Affected software versions or configurations + - Any known limitations or edge cases + validations: + required: false