hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2025-12-16 16:53:25 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update query-metadata-style-guide.md clarify problem.severity

Browse Source
This commit is contained in:
Andrew Eisenberg
2024-01-10 13:47:35 -08:00
committed by GitHub
parent 51fe477ed1
commit 303272d0d4
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/query-metadata-style-guide.md
View File

@@ -113,7 +113,7 @@ Alert queries (`@kind problem` or `path-problem`) support two further properties
* `medium`
* `high`
* `very-high`
* `@problem.severity`–defines the level of severity of non-security alerts:
* `@problem.severity`–defines the likelihood that an alert, either security-related or not, causes an actual problem:
* `error`–an issue that is likely to cause incorrect program behavior, for example a crash or vulnerability.
* `warning`–an issue that indicates a potential problem in the code, or makes the code fragile if another (unrelated) part of code is changed.
* `recommendation`–an issue where the code behaves correctly, but it could be improved.