From c02e66830bc2939a9278702fcfaffeca4ea4b973 Mon Sep 17 00:00:00 2001 From: Edward Muller Date: Wed, 25 May 2016 09:18:04 -0700 Subject: [PATCH] Add a FAQ --- FAQ.md | 9 +++++++++ Readme.md | 2 ++ 2 files changed, 11 insertions(+) create mode 100644 FAQ.md diff --git a/FAQ.md b/FAQ.md new file mode 100644 index 0000000..11b9ba8 --- /dev/null +++ b/FAQ.md @@ -0,0 +1,9 @@ +## Why do I need to check in `vendor/`? + +godep's primary concern is to allow you to repeatably build your project. Your +dependencies are part of that project. Without them it won't build. Not +committing `vendor/` adds additional external dependencies that are outside of +your control. In Go, fetching packages is tied to multiple external systems +(DNS, web servers, etc). Over time other developers or code hosting sites may +discontinue service, delete code, force push, or take any number of other +actions that may make a package unreachable. \ No newline at end of file diff --git a/Readme.md b/Readme.md index d5e9965..d014231 100644 --- a/Readme.md +++ b/Readme.md @@ -10,6 +10,8 @@ This tool assumes you are working in a standard Go workspace, as described in http://golang.org/doc/code.html. We expect godep to build on Go 1.4* or newer, but you can use it on any project that works with Go 1 or newer. +Please check the [FAQ](FAQ.md) if you have a question. + ## Install ```console