From 16d86d95aa3a23c120a3a80b0e9a7e41fbf44d70 Mon Sep 17 00:00:00 2001 From: Yong Tang Date: Thu, 1 Jun 2017 11:02:47 -0700 Subject: [PATCH] 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 --- CONTRIBUTING.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) 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.