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

Rust: add documentation

Browse Source
This commit is contained in:
Paolo Tranquilli
2025-06-06 16:19:20 +02:00
parent c70decbe86
commit f3e4f94e81
13 changed files with 410 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -25,6 +25,7 @@ For examples of query files for the languages supported by CodeQL, visit the fol
* [JavaScript queries](https://codeql.github.com/codeql-query-help/javascript/)
* [Python queries](https://codeql.github.com/codeql-query-help/python/)
* [Ruby queries](https://codeql.github.com/codeql-query-help/ruby/)
* [Rust queries](https://codeql.github.com/codeql-query-help/rust/)
* [Swift queries](https://codeql.github.com/codeql-query-help/swift/)
## Metadata area
@@ -154,7 +155,7 @@ When you tag a query like this, the associated CWE pages from [MITRE.org](https:
* `@tags maintainability`–for queries that detect patterns that make it harder for developers to make changes to the code.
* `@tags reliability`–for queries that detect issues that affect whether the code will perform as expected during execution.
Software quality doesn't have as universally-agreed categorization method as security issues like CWE, so we will do our own categorization instead of using tags like CWE.
Software quality doesn't have as universally-agreed categorization method as security issues like CWE, so we will do our own categorization instead of using tags like CWE.
We'll use two "top-level" categories of quality queries, with sub-categories beneath:
@@ -162,7 +163,7 @@ We'll use two "top-level" categories of quality queries, with sub-categories ben
* `@tags readability`–for queries that detect confusing patterns that make it harder for developers to read the code.
* `@tags useless-code`-for queries that detect functions that are never used and other instances of unused code
* `@tags complexity`-for queries that detect patterns in the code that lead to unnecesary complexity such as unclear control flow, or high cyclomatic complexity
* `@tags reliability`–for queries that detect issues that affect whether the code will perform as expected during execution.
* `@tags correctness`–for queries that detect incorrect program behavior or couse result in unintended outcomes.