1# Contributing to the registry
2
3## Before reporting an issue...
4
5### If your problem is with...
6
7 - automated builds
8 - your account on the [Docker Hub](https://hub.docker.com/)
9 - any other [Docker Hub](https://hub.docker.com/) issue
10
11Then please do not report your issue here - you should instead report it to [https://support.docker.com](https://support.docker.com)
12
13### If you...
14
15 - need help setting up your registry
16 - can't figure out something
17 - are not sure what's going on or what your problem is
18
19Then please do not open an issue here yet - you should first try one of the following support forums:
20
21 - irc: #docker-distribution on freenode
22 - mailing-list: <distribution@dockerproject.org> or https://groups.google.com/a/dockerproject.org/forum/#!forum/distribution
23
24### Reporting security issues
25
26The Docker maintainers take security seriously. If you discover a security
27issue, please bring it to their attention right away!
28
29Please **DO NOT** file a public issue, instead send your report privately to
30[security@docker.com](mailto:security@docker.com).
31
32## Reporting an issue properly
33
34By following these simple rules you will get better and faster feedback on your issue.
35
36 - search the bugtracker for an already reported issue
37
38### If you found an issue that describes your problem:
39
40 - please read other user comments first, and confirm this is the same issue: a given error condition might be indicative of different problems - you may also find a workaround in the comments
41 - please refrain from adding "same thing here" or "+1" comments
42 - you don't need to comment on an issue to get notified of updates: just hit the "subscribe" button
43 - comment if you have some new, technical and relevant information to add to the case
44 - __DO NOT__ comment on closed issues or merged PRs. If you think you have a related problem, open up a new issue and reference the PR or issue.
45
46### If you have not found an existing issue that describes your problem:
47
48 1. create a new issue, with a succinct title that describes your issue:
49 - bad title: "It doesn't work with my docker"
50 - good title: "Private registry push fail: 400 error with E_INVALID_DIGEST"
51 2. copy the output of:
52 - `docker version`
53 - `docker info`
54 - `docker exec <registry-container> registry --version`
55 3. copy the command line you used to launch your Registry
56 4. restart your docker daemon in debug mode (add `-D` to the daemon launch arguments)
57 5. reproduce your problem and get your docker daemon logs showing the error
58 6. if relevant, copy your registry logs that show the error
59 7. provide any relevant detail about your specific Registry configuration (e.g., storage backend used)
60 8. indicate if you are using an enterprise proxy, Nginx, or anything else between you and your Registry
61
62## Contributing a patch for a known bug, or a small correction
63
64You should follow the basic GitHub workflow:
65
66 1. fork
67 2. commit a change
68 3. make sure the tests pass
69 4. PR
70
71Additionally, you must [sign your commits](https://github.com/docker/docker/blob/master/CONTRIBUTING.md#sign-your-work). It's very simple:
72
73 - configure your name with git: `git config user.name "Real Name" && git config user.email mail@example.com`
74 - sign your commits using `-s`: `git commit -s -m "My commit"`
75
76Some simple rules to ensure quick merge:
77
78 - clearly point to the issue(s) you want to fix in your PR comment (e.g., `closes #12345`)
79 - prefer multiple (smaller) PRs addressing individual issues over a big one trying to address multiple issues at once
80 - if you need to amend your PR following comments, please squash instead of adding more commits
81
82## Contributing new features
83
84You are heavily encouraged to first discuss what you want to do. You can do so on the irc channel, or by opening an issue that clearly describes the use case you want to fulfill, or the problem you are trying to solve.
85
86If this is a major new feature, you should then submit a proposal that describes your technical solution and reasoning.
87If you did discuss it first, this will likely be greenlighted very fast. It's advisable to address all feedback on this proposal before starting actual work.
88
89Then you should submit your implementation, clearly linking to the issue (and possible proposal).
90
91Your PR will be reviewed by the community, then ultimately by the project maintainers, before being merged.
92
93It's mandatory to:
94
95 - interact respectfully with other community members and maintainers - more generally, you are expected to abide by the [Docker community rules](https://github.com/docker/docker/blob/master/CONTRIBUTING.md#docker-community-guidelines)
96 - address maintainers' comments and modify your submission accordingly
97 - write tests for any new code
98
99Complying to these simple rules will greatly accelerate the review process, and will ensure you have a pleasant experience in contributing code to the Registry.
100
101Have a look at a great, successful contribution: the [Swift driver PR](https://github.com/docker/distribution/pull/493)
102
103## Coding Style
104
105Unless explicitly stated, we follow all coding guidelines from the Go
106community. While some of these standards may seem arbitrary, they somehow seem
107to result in a solid, consistent codebase.
108
109It is possible that the code base does not currently comply with these
110guidelines. We are not looking for a massive PR that fixes this, since that
111goes against the spirit of the guidelines. All new contributions should make a
112best effort to clean up and make the code base better than they left it.
113Obviously, apply your best judgement. Remember, the goal here is to make the
114code base easier for humans to navigate and understand. Always keep that in
115mind when nudging others to comply.
116
117The rules:
118
1191. All code should be formatted with `gofmt -s`.
1202. All code should pass the default levels of
121 [`golint`](https://github.com/golang/lint).
1223. All code should follow the guidelines covered in [Effective
123 Go](http://golang.org/doc/effective_go.html) and [Go Code Review
124 Comments](https://github.com/golang/go/wiki/CodeReviewComments).
1254. Comment the code. Tell us the why, the history and the context.
1265. Document _all_ declarations and methods, even private ones. Declare
127 expectations, caveats and anything else that may be important. If a type
128 gets exported, having the comments already there will ensure it's ready.
1296. Variable name length should be proportional to its context and no longer.
130 `noCommaALongVariableNameLikeThisIsNotMoreClearWhenASimpleCommentWouldDo`.
131 In practice, short methods will have short variable names and globals will
132 have longer names.
1337. No underscores in package names. If you need a compound name, step back,
134 and re-examine why you need a compound name. If you still think you need a
135 compound name, lose the underscore.
1368. No utils or helpers packages. If a function is not general enough to
137 warrant its own package, it has not been written generally enough to be a
138 part of a util package. Just leave it unexported and well-documented.
1399. All tests should run with `go test` and outside tooling should not be
140 required. No, we don't need another unit testing framework. Assertion
141 packages are acceptable if they provide _real_ incremental value.
14210. Even though we call these "rules" above, they are actually just
143 guidelines. Since you've read all the rules, you now know that.
144
145If you are having trouble getting into the mood of idiomatic Go, we recommend
146reading through [Effective Go](http://golang.org/doc/effective_go.html). The
147[Go Blog](http://blog.golang.org/) is also a great resource. Drinking the
148kool-aid is a lot easier than going thirsty.
View as plain text