StackExchange/dnscontrol
1
1
Fork 0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2025-09-08 14:15:30 +08:00
Code Issues Projects Releases Packages Wiki Activity

DOCS: Fix golint and vendoring notes (#948)

Browse source
This commit is contained in:
Tom Limoncelli 2020-11-15 14:47:52 -05:00 • committed by GitHub
parent 7db3741bc7
commit 18c026d7d9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
docs/writing-providers.md
View file

@ -226,11 +226,11 @@ the documentation.
Run "go vet" and "golint" and clean up any errors found. Run "go vet" and "golint" and clean up any errors found.
``` ```
go vet go vet ./...
golint golint ./...
``` ```
Please use `go vet` from the [newest releaes of Go](https://golang.org/doc/devel/release.html#policy). Please use `go vet` from the [newest release of Go](https://golang.org/doc/devel/release.html#policy).
If [golint](https://github.com/golang/lint) isn't installed on your machine: If [golint](https://github.com/golang/lint) isn't installed on your machine:
@ -239,30 +239,7 @@ go get -u golang.org/x/lint/golint
``` ```
## Step 12: Vendor Dependencies ## Step 12: Dependencies
The build process for DNSControl uses the default Go Modules system,
which ignores the `vendor` directory. However we store a backup copy
of all dependencies by using the `go mod vendor` command. It makes
our repo larger, but makes Tom feel better because he's been burnt by
modules disappearing on him.
What this means:
1. If you require a Go dependency, get it using `go get -u`. For
example:
```
go get -u github.com/aws/aws-sdk-go
```
2. Before you send any PRs, please make sure the dependencies are
vendored. Use these commands:
```
go mod vendor
go mod tidy
```
See See
[docs/release-engineering.md](https://github.com/StackExchange/dnscontrol/blob/master/docs/release-engineering.md) [docs/release-engineering.md](https://github.com/StackExchange/dnscontrol/blob/master/docs/release-engineering.md)