From 08d0718eccd3f5d51b5597d58a13641cb324a68f Mon Sep 17 00:00:00 2001 From: calum Date: Mon, 20 Aug 2018 11:06:22 +0100 Subject: [PATCH] Update CONTRIBUTING.md and README.md to link the the QL Style Guide. --- CONTRIBUTING.md | 2 ++ README.md | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 784c0518bf9..7bd105284bb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,6 +4,8 @@ We welcome contributions to our standard library and standard checks, got an ide Before we accept your pull request, we will require that you have agreed to our Contributor License Agreement, this is not something that you need to do before you submit your pull request, but until you've done so, we will be unable to accept your contribution. +Please read our [QL Style Guide](docs/ql-style-guide.md) for information on how to format QL code in this repository. + ## Using your personal data If you contribute to this project, we will record your name and email diff --git a/README.md b/README.md index b6bc56565f0..b906190a475 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). +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). ## License