From 7b0f62208ffefabefd3d12583348b5f0422c7e4a Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Tue, 17 Oct 2017 17:11:00 +0100 Subject: [PATCH] Mention how to run the linters in documentation (#310) Closes #309 --- CODE_STYLE.md | 4 ++++ CONTRIBUTING.md | 3 ++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/CODE_STYLE.md b/CODE_STYLE.md index 0e0a043ad..65d0daf4c 100644 --- a/CODE_STYLE.md +++ b/CODE_STYLE.md @@ -15,6 +15,10 @@ for that line or statement using a [comment directive](https://github.com/alecth `// nolint: gocyclo`. This should be used sparingly and only when its clear that the lint warning is spurious. +The linters are vendored, and can be run using [scripts/find-lint.sh](scripts/find-lint.sh) +(see file for docs) or as part of a build/test/lint cycle using +[scripts/build-test-lint.sh](scripts/build-test-lint.sh). + ## HTTP Error Handling diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 616588a59..256106faa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,7 +13,8 @@ instance of dendrite, and [CODE_STYLE.md](CODE_STYLE.md) for the code style guide. We use `gb` for managing our dependencies, so `gb build` and `gb test` is how -to build dendrite and run the unit tests respectively. +to build dendrite and run the unit tests respectively. There are [scripts](scripts) +for [linting](scripts/find-lint.sh) and doing a [build/test/lint run](scripts/build-test-lint.sh). ## Picking Things To Do