From 29e46cf34705bacfbf2abe34b681615a47e772e6 Mon Sep 17 00:00:00 2001 From: james Date: Tue, 28 May 2019 21:33:36 +0100 Subject: [PATCH] docs: add link to style guides in readme --- README.md | 2 +- docs/query-help-style-guide.md | 2 +- docs/query-metadata-style-guide.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 00fcbd6ba10..b483d29cae2 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ You can use the [interactive query console](https://lgtm.com/help/lgtm/using-que ## Contributing -We welcome contributions to our standard library and standard checks. Do you have an idea for a new check, or how to improve an existing query? Then please go ahead and open a pull request! Before you do, though, please take the time to read our [contributing guidelines](CONTRIBUTING.md) and [QL style guide](docs/ql-style-guide.md). +We welcome contributions to our standard library and standard checks. Do you have an idea for a new check, or how to improve an existing query? Then please go ahead and open a pull request! Before you do, though, please take the time to read our [contributing guidelines](CONTRIBUTING.md). You can also consult our [style guides](https://github.com/Semmle/ql/tree/master/docs) to learn how to format your QL for consistency and clarity, how to write query metadata, and how to write query help documentation for your query. ## License diff --git a/docs/query-help-style-guide.md b/docs/query-help-style-guide.md index 8e0d3ee3297..c808a6eb271 100644 --- a/docs/query-help-style-guide.md +++ b/docs/query-help-style-guide.md @@ -36,7 +36,7 @@ Section-level elements are used to group the information within the query help f 3. `example`—an example of code showing the problem. Where possible, this section should also include a solution to the issue. 4. `references`—relevant references, such as authoritative sources on language semantics and best practice. -For further information about the other section-level, block, list and table elements supported by the qhelp format, see [Qhelp files](https://help.semmle.com/wiki/display/SD/Qhelp+files). +For further information about the other section-level, block, list and table elements supported by the qhelp format, see the [Qhelp reference](https://help.semmle.com/QL/learn-ql/ql/writing-queries/query-help.html) on help.semmle.com. ## English style diff --git a/docs/query-metadata-style-guide.md b/docs/query-metadata-style-guide.md index 3d4e1118f6a..32a82a59bd4 100644 --- a/docs/query-metadata-style-guide.md +++ b/docs/query-metadata-style-guide.md @@ -43,7 +43,7 @@ Query file metadata contains important information which defines the identifier */ ``` -In order to help others use your query, and to ensure that the query works correctly on LGTM, you should include all of the required information outlined below in the metadata, and as much of the optional information as possible. For further information on query metadata see [Query file requirements](https://help.semmle.com/wiki/display/SD/Query+file+requirements). +In order to help others use your query, and to ensure that the query works correctly on LGTM, you should include all of the required information outlined below in the metadata, and as much of the optional information as possible. For further information on query metadata see the [Query meta reference](https://help.semmle.com/QL/learn-ql/ql/writing-queries/query-metadata.html) on help.semmle.com. ### Query name `@name`