mirrors/dendrite
1
0
Fork 0
mirror of https://github.com/matrix-org/dendrite.git synced 2025-12-13 09:53:10 -06:00
Code Issues Packages Projects Releases Wiki Activity

Mention how to run the linters in documentation

Browse source 
Closes #309
This commit is contained in:
Erik Johnston 2017-10-16 15:00:33 +01:00
parent bd07447abe
commit d362fbc90c
2 changed files with 6 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
CODE_STYLE.md
View file

@ -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 `// nolint: gocyclo`. This should be used sparingly and only when its clear
that the lint warning is spurious. 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 ## HTTP Error Handling

3
CONTRIBUTING.md
View file

@ -13,7 +13,8 @@ instance of dendrite, and [CODE_STYLE.md](CODE_STYLE.md) for the code style
guide. guide.
We use `gb` for managing our dependencies, so `gb build` and `gb test` is how 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 ## Picking Things To Do