Skip to content

Commit

Permalink
Merge pull request #1205 from helmholtz-analytics/docs/1186-Update_RE…
Browse files Browse the repository at this point in the history
…ADME

Update README and documentation
  • Loading branch information
mrfh92 committed Oct 5, 2023
2 parents 43d0a38 + fc49fc5 commit 8fd61d6
Show file tree
Hide file tree
Showing 9 changed files with 1,169 additions and 231 deletions.
30 changes: 15 additions & 15 deletions .github/ISSUE_TEMPLATE/vulnerability.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: "Vulnerability Report"
name: "\U0001F6A8 Vulnerability Report"
description: Report a security vulnerability in our project.
title: "[VULNERABILITY]: "
labels: ["security, High Priority"]
Expand All @@ -14,50 +14,50 @@ body:
attributes:
label: Affected Version(s)
description: List the affected versions of the library.
validations:
required: true
validations:
required: true
- type: textarea
id: severity
attributes:
label: Severity
description: Specify the severity of the vulnerability (e.g., Low/Medium/High/Critical).
validations:
required: true
validations:
required: true
- type: textarea
id: description
attributes:
label: Description
description: Provide a clear and concise description of the security vulnerability.
validations:
required: true
validations:
required: true
- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to Reproduce
description: Outline the steps to reproduce the vulnerability, including any relevant code snippets or configuration settings.
validations:
required: true
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: Explain what you expected to happen when following the steps above.
validations:
required: true
validations:
required: true
- type: textarea
id: actual-behavior
attributes:
label: Actual Behavior
description: Describe what actually happened when you followed the steps above, highlighting the security issue.
validations:
required: true
validations:
required: true
- type: textarea
id: impact
attributes:
label: Impact
description: Discuss the potential impact of this vulnerability, including any possible consequences or risks associated with its exploitation.
validations:
required: true
validations:
required: true
- type: textarea
id: proof-of-concept
attributes:
Expand Down
212 changes: 119 additions & 93 deletions README.md

Large diffs are not rendered by default.

Loading

0 comments on commit 8fd61d6

Please sign in to comment.