kubernetes
/
community
mirror of https://github.com/kubernetes/community.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2274 from tpepper/cleaning 

contributors/devel: request better godep vendoring commit messages
This commit is contained in:
k8s-ci-robot 2018-06-18 13:46:32 -07:00 committed by GitHub
parent 1d40f19654 2d8e8181fa
commit 1cc1e3b804
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
contributors/devel/godep.md
View File

@ -156,6 +156,22 @@ transitively), you'll also need to update deps there:
./hack/update-staging-godeps.sh
```
## Commit messages
Terse messages like "Update foo.org/bar to 0.42" are problematic
for maintainability. Please include in your commit message the
detailed reason why the dependencies were modified.
Too commonly dependency changes have a ripple effect where something
else breaks unexpectedly. The first instinct during issue triage
is to revert a change. If the change was made to fix some other
issue and that issue was not documented, then a revert simply
continues the ripple by fixing one issue and reintroducing another
which then needs refixed. This can needlessly span multiple days
as CI results bubble in and subsequent patches fix and refix and
rerefix issues. This may be avoided if the original modifications
recorded artifacts of the change rationale.
## Sanity checking
After all of this is done, `git status` should show you what files have been