Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve false positive issue templat #7130

Merged
merged 1 commit into from
Nov 6, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions .github/ISSUE_TEMPLATE/false-positive-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,28 +6,36 @@ body:
- type: markdown
attributes:
value: |
False Positive identified.
**Automation is used to process most false positives reports**; failure to follow these guidelines will delay the process:

- Only enter a **single (1) Package URL**.
- Only enter a **single (1) CPE or CVE**.
- If filing a CPE report you do not need to add the CVEs. Note that **most reports should be for incorrectly matched CPEs**.

If reporting false positives for multiple PURL and/or CPE please file multiple reports.

Thank you for filing a false positive report!
- type: input
id: purl
attributes:
label: Package URl
description: The identified package URL as identified in the HTML Report.
description: Please enter the single identified package URL as identified in the HTML Report. Only a **single PURL** can be specified, if you are reporting more then one - please open two issues using this template.
placeholder: ex. pkg:maven/org.apache.logging.log4j/[email protected]
validations:
required: true
- type: input
id: cpe
attributes:
label: CPE
description: The Common Platform enumeration (CPE) as identified in the HTML Report. Please put backtic characters around the CPE to ensure it displays correctly.
description: Please enter the single Common Platform enumeration (CPE) as identified in the HTML Report. Only a **single CPE** can be specified. **Please put backtic characters around the CPE to ensure it displays correctly**.
placeholder: ex. `cpe:2.3:a:apache:log4j:2.12.1:*:*:*:*:*:*:*`
validations:
required: true
- type: input
id: cve
attributes:
label: CVE
description: The vulnerability name as identified in the HTML Report. This is optional and may not be needed as most FP reports are due to an incorrect CPE.
description: The vulnerability name as identified in the HTML Report. If specifying a CPE this is not necassary; if entered please enter only a **signle CVE**; if multiple CVE should be suppressed please enter multiple FP reports. This is optional and may not be needed as most FP reports are due to an incorrect CPE.
placeholder: ex. CVE-2021-44228
validations:
required: false
Expand Down
Loading