aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorGravatar Yong Tang <yong.tang.github@outlook.com> 2017-06-01 11:02:47 -0700
committerGravatar GitHub <noreply@github.com> 2017-06-01 11:02:47 -0700
commit16d86d95aa3a23c120a3a80b0e9a7e41fbf44d70 (patch)
tree61be9b0eba62519b9d7d9f04bdb92f4993eb8a3e /CONTRIBUTING.md
parent3752a97135e93ca32f052375f22e6c2419e2ce4c (diff)
downloadcoredns-16d86d95aa3a23c120a3a80b0e9a7e41fbf44d70.tar.gz
coredns-16d86d95aa3a23c120a3a80b0e9a7e41fbf44d70.tar.zst
coredns-16d86d95aa3a23c120a3a80b0e9a7e41fbf44d70.zip
Update CONTRIBUTING.md to add the section for vendor management. (#688)
This commit updates CONTRIBUTING.md to add a section for vendor management. Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index cae1d899c..19d097d0b 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -85,3 +85,30 @@ for d in *; do
golint "$d"/...
done
~~~
+
+## Updating Dependencies
+
+We use Golang's [`dep`](https://github.com/golang/dep) as the tool to manage vendor dependencies.
+The tool could be obtained through:
+
+```sh
+$ go get -u github.com/golang/dep/cmd/dep
+```
+
+Use the following to update the locked versions of all dependencies
+```sh
+$ dep ensure -update
+```
+
+To add a dependency to the project, you might run
+```sh
+$ dep ensure github.com/pkg/errors
+```
+
+After the dependencies have been updated or added, you might run the following to
+prune vendored packages:
+```sh
+$ dep prune
+```
+
+Please refer to Golang's [`dep`](https://github.com/golang/dep) for more details.