diff options
| author | oliverpool <3864879+oliverpool@users.noreply.github.com> | 2020-08-24 19:13:43 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-08-24 18:13:43 +0100 |
| commit | 466d795375dad5d9ca597f0105ee56564684bb8f (patch) | |
| tree | 430e3c167843c2af0c5269935f381e6fa40a3e5a /docs | |
| parent | 4b2db1dff5011e954f5d3fbb46a6bf55d2019bd3 (diff) | |
Fix scripts path in documentation (#1294)
Broken by 24d8df664c21fa8bd68d80b5585a496e264c410a
Signed-off-by: Olivier Charvin <git@olivier.pfad.fr>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/CODE_STYLE.md | 4 | ||||
| -rw-r--r-- | docs/CONTRIBUTING.md | 8 |
2 files changed, 6 insertions, 6 deletions
diff --git a/docs/CODE_STYLE.md b/docs/CODE_STYLE.md index 248d7610..8f1c1cb5 100644 --- a/docs/CODE_STYLE.md +++ b/docs/CODE_STYLE.md @@ -12,9 +12,9 @@ directive](https://github.com/golangci/golangci-lint#nolint), e.g. `var bad_name int //nolint:golint,unused`. This should be used sparingly and only when its clear that the lint warning is spurious. -The linters can be run using [scripts/find-lint.sh](scripts/find-lint.sh) +The linters can be run using [build/scripts/find-lint.sh](/build/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). +[build/scripts/build-test-lint.sh](/build/scripts/build-test-lint.sh). ## Labels diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 0bcd2bb1..72a588af 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -16,9 +16,9 @@ As of May 2019, we're not using `gb` anymore, which is the tool we had been using for managing our dependencies. We're now using Go modules. To build Dendrite, run the `build.sh` script at the root of this repository (which runs `go install` under the hood), and to run unit tests, run `go test ./...` (which -should pick up any unit test and run it). There are also [scripts](scripts) for -[linting](scripts/find-lint.sh) and doing a [build/test/lint -run](scripts/build-test-lint.sh). +should pick up any unit test and run it). There are also [build/scripts](/build/scripts) for +[linting](/build/scripts/find-lint.sh) and doing a [build/test/lint +run](/build/scripts/build-test-lint.sh). As of February 2020, we are deprecating support for Go 1.11 and Go 1.12 and are now targeting Go 1.13 or later. Please ensure that you are using at least Go @@ -49,7 +49,7 @@ To save waiting for CI to finish after every commit, it is ideal to run the checks locally before pushing, fixing errors first. This also saves other people time as only so many PRs can be tested at a given time. -To execute what Buildkite tests, first run `./scripts/build-test-lint.sh`; this +To execute what Buildkite tests, first run `./build/scripts/build-test-lint.sh`; this script will build the code, lint it, and run `go test ./...` with race condition checking enabled. If something needs to be changed, fix it and then run the script again until it no longer complains. Be warned that the linting can take a |