Skip to content

Commit b24c096

Browse files
Apply suggestions from code review
Co-authored-by: Aditya Sharad <[email protected]>
1 parent d1a4f57 commit b24c096

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

docs/query-help-style-guide.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,14 +112,17 @@ If your query checks code for a CWE weakness, you should use the `@tags` element
112112

113113
## Validating qhelp files
114114

115-
Before making a pull request you should ensure the `.qhelp` file is well-formed and can be generated without problems. For example, this can be done locally with `codeql-cli` tool. In order to do so just start the `codeql-cli` with the appropriate parameters, as seen in the following example:
115+
Before making a pull request, please ensure the `.qhelp` files are well-formed and can be generated without errors. This can be done locally with the CodeQL CLI, as shown in the following example:
116116

117117
```bash
118118
# codeql generate query-help <path_to_your_qhelp_file> --format=<format>
119119
# For example:
120120
codeql generate query-help ./myCustomQuery.qhelp --format=markdown
121121
```
122122

123+
124+
Please include the `.qhelp` files (and any associated code snippets) in your pull request, but do not commit the generated Markdown.
125+
123126
More information on how to test your `.qhelp` files can be found [within the documentation](https://codeql.github.com/docs/codeql-cli/testing-query-help-files/)
124127

125128
## Query help example

0 commit comments

Comments
 (0)