From 1deb27d130135cddae94b901dd6d2f8327738719 Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Wed, 6 Mar 2019 09:59:47 +0000 Subject: [PATCH] docs: Add more vendor details to contributing guide Explain that it is necessary to `git add vendor/` after running `dep ensure`. Fixes #88. Signed-off-by: James O. D. Hunt --- CONTRIBUTING.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d7f683ce..13d3d4c5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -588,7 +588,16 @@ The following steps outline the full Assisted PR workflow: ### Re-vendor PRs If you raise a PR to update the vendored copy of one or more golang packages, -there are two critical pieces of information you need to add to the commit +after running the +[`dep`](https://github.com/kata-containers/community/blob/master/VENDORING.md) +command ensure you add any modified files under the `vendor/` directory to Git +before committing the changes: + +```sh +$ git add vendor/ +``` + +There are two critical pieces of information you need to add to the commit body: - A brief explanation why the re-vendor is required.