Skip to content

Commit

Permalink
docs: Add more vendor details to contributing guide
Browse files Browse the repository at this point in the history
Explain that it is necessary to `git add vendor/` after running `dep
ensure`.

Fixes kata-containers#88.

Signed-off-by: James O. D. Hunt <[email protected]>
  • Loading branch information
jodh-intel committed Mar 6, 2019
1 parent 86c89d2 commit 1deb27d
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 1deb27d

Please sign in to comment.