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

Add risk level severities to docs #4037

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

stephanie0x00
Copy link
Contributor

Changes

This PR adds a description on the various risk severities used within OpenKAT, as this was not documented.

Issue link

Issue: #1429
Closes: #1429

Demo

n/a

QA notes

Double check if you agree with the text for the risk levels and if anything important is forgotten, or if things should be more nuanced/are missing.


Code Checklist

  • All the commits in this PR are properly PGP-signed and verified.
  • This PR only contains functionality relevant to the issue.
  • I have written unit tests for the changes or fixes I made.
  • I have checked the documentation and made changes where necessary.
  • I have performed a self-review of my code and refactored it to the best of my abilities.
  • Tickets have been created for newly discovered issues.
  • For any non-trivial functionality, I have added integration and/or end-to-end tests.
  • I have informed others of any required .env changes files if required and changed the .env-dist accordingly.
  • I have included comments in the code to elaborate on what is not self-evident from the code itself, including references to issues and discussions online, or implicit behavior of an interface.

Checklist for code reviewers:

Copy-paste the checklist from the docs/source/templates folder into your comment.


Checklist for QA:

Copy-paste the checklist from the docs/source/templates folder into your comment.

@stephanie0x00 stephanie0x00 requested a review from a team as a code owner January 21, 2025 11:15
@stephanie0x00 stephanie0x00 added the documentation Improvements or additions to documentation label Jan 21, 2025
Co-authored-by: Jan Klopper <janklopper+underdark@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Ready for merge
Development

Successfully merging this pull request may close these issues.

Add explanation of what the risk/severity levels constitute to the docs
3 participants