From c0ebf12ab0bfcde6482cd2f08c913c6ac8b59a4d Mon Sep 17 00:00:00 2001 From: Felicity Chapman Date: Tue, 5 May 2020 13:25:19 +0100 Subject: [PATCH] Update requirements for docs review --- CODEOWNERS | 9 +++++++++ docs/supported-queries.md | 1 + 2 files changed, 10 insertions(+) diff --git a/CODEOWNERS b/CODEOWNERS index c3d6dd1fc12..64bda94db77 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -3,9 +3,18 @@ /java/ @github/codeql-java /javascript/ @github/codeql-javascript /python/ @github/codeql-python + +# Assign query help for docs review /cpp/**/*.qhelp @hubwriter /csharp/**/*.qhelp @jf205 /java/**/*.qhelp @felicitymay /javascript/**/*.qhelp @mchammer01 /python/**/*.qhelp @felicitymay /docs/language/ @shati-patel @jf205 + +# Exclude help for experimental queries from docs review +/cpp/**/experimental/**/*.qhelp @github/codeql-c-analysis +/csharp/**/experimental/**/*.qhelp @github/codeql-csharp +/java/**/experimental/**/*.qhelp @github/codeql-java +/javascript/**/experimental/**/*.qhelp @github/codeql-javascript +/python/**/experimental/**/*.qhelp @github/codeql-python diff --git a/docs/supported-queries.md b/docs/supported-queries.md index fd7af7195aa..dc02a1e547c 100644 --- a/docs/supported-queries.md +++ b/docs/supported-queries.md @@ -77,3 +77,4 @@ The process must begin with the first step and must conclude with the final step - The structure of an `experimental` subdirectory mirrors the structure of its parent directory, so this step may just be a matter of removing the `experimental/` prefix of the query and test paths. Be sure to also edit any references to the query path in tests. - Add the query to one of the legacy suite files in `ql//config/suites//` if it exists. Note that there are separate suite directories for C and C++, `c` and `cpp` respectively, and the query should be added to one or both as appropriate. - Add a release note to `change-notes//analysis-.md`. + - Your pull request will be flagged automatically for a review by the documentation team to ensure that the query help file is ready for wider use.