summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authork8s-ci-robot <k8s-ci-robot@users.noreply.github.com>2018-11-09 11:00:31 -0800
committerGitHub <noreply@github.com>2018-11-09 11:00:31 -0800
commit13964e8d85ef09b0fa4e48e8d49cb0e63d82e9bf (patch)
treec505c8466fc7c7b0524e62c2083ebfbd432c9d6c
parent6fb5d423f351ac24891a4bea0cf4225bb80a19fd (diff)
parentc18b45800e498947207d487bed11c47a59e2c16a (diff)
Merge pull request #2918 from deads2k/godep-update
add acceptable justifications for updating a godep
-rw-r--r--contributors/devel/godep.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/contributors/devel/godep.md b/contributors/devel/godep.md
index ec798295..4b10a7d5 100644
--- a/contributors/devel/godep.md
+++ b/contributors/devel/godep.md
@@ -15,6 +15,19 @@ the tools.
This doc will focus on predictability and reproducibility.
+## Justifications for an update
+
+Before you update a dependency, take a moment to consider why it should be
+updated. Valid reasons include:
+ 1. We need new functionality that is in a later version.
+ 2. New or improved APIs in the dependency significantly improve Kubernetes code.
+ 3. Bugs were fixed that impact Kubernetes.
+ 4. Security issues were fixed even if they don't impact Kubernetes yet.
+ 5. Performance, scale, or efficiency was meaningfully improved.
+ 6. We need dependency A and there is a transitive dependency B.
+ 7. Kubernetes has an older level of a dependency that is precluding being able
+to work with other projects in the ecosystem.
+
## Theory of operation
The `go` toolchain assumes a global workspace that hosts all of your Go code.