Skip to content

Latest commit

 

History

History
140 lines (103 loc) · 7.19 KB

CONTRIBUTING.md

File metadata and controls

140 lines (103 loc) · 7.19 KB
Raw

Contributing to the registry

## Before reporting an issue...

If your problem is with...

Then please do not report your issue here - you should instead report it to https://support.docker.com

If you...

  • need help setting up your registry
  • can't figure out something
  • are not sure what's going on or what your problem is

Then please do not open an issue here yet - you should first try one of the following support forums:

Reporting an issue properly

By following these simple rules you will get better and faster feedback on your issue.

  • search the bugtracker for an already reported issue

### If you found an issue that describes your problem:

  • 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
  • please refrain from adding "same thing here" or "+1" comments
  • you don't need to comment on an issue to get notified of updates: just hit the "subscribe" button
  • comment if you have some new, technical and relevant information to add to the case
  • 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.

If you have not found an existing issue that describes your problem:

  1. create a new issue, with a succinct title that describes your issue:
  • bad title: "It doesn't work with my docker"
  • good title: "Private registry push fail: 400 error with E_INVALID_DIGEST"
  1. copy the output of:
  • docker version
  • docker info
  • docker exec <registry-container> registry -version
  1. copy the command line you used to launch your Registry
  2. restart your docker daemon in debug mode (add -D to the daemon launch arguments)
  3. reproduce your problem and get your docker daemon logs showing the error
  4. if relevant, copy your registry logs that show the error
  5. provide any relevant detail about your specific Registry configuration (e.g., storage backend used)
  6. indicate if you are using an enterprise proxy, Nginx, or anything else between you and your Registry

Contributing a patch for a known bug, or a small correction

You should follow the basic GitHub workflow:

  1. fork
  2. commit a change
  3. make sure the tests pass
  4. PR

Additionally, you must sign your commits. It's very simple:

  • configure your name with git: git config user.name "Real Name" && git config user.email mail@example.com
  • sign your commits using -s: git commit -s -m "My commit"

Some simple rules to ensure quick merge:

  • clearly point to the issue(s) you want to fix in your PR comment (e.g., closes #12345)
  • prefer multiple (smaller) PRs addressing individual issues over a big one trying to address multiple issues at once
  • if you need to amend your PR following comments, please squash instead of adding more commits

Contributing new features

You 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.

If this is a major new feature, you should then submit a proposal that describes your technical solution and reasoning. If 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.

Then you should submit your implementation, clearly linking to the issue (and possible proposal).

Your PR will be reviewed by the community, then ultimately by the project maintainers, before being merged.

It's mandatory to:

  • interact respectfully with other community members and maintainers - more generally, you are expected to abide by the Docker community rules
  • address maintainers' comments and modify your submission accordingly
  • write tests for any new code

Complying to these simple rules will greatly accelerate the review process, and will ensure you have a pleasant experience in contributing code to the Registry.

Have a look at a great, successful contribution: the Swift driver PR

Coding Style

Unless explicitly stated, we follow all coding guidelines from the Go community. While some of these standards may seem arbitrary, they somehow seem to result in a solid, consistent codebase.

It is possible that the code base does not currently comply with these guidelines. We are not looking for a massive PR that fixes this, since that goes against the spirit of the guidelines. All new contributions should make a best effort to clean up and make the code base better than they left it. Obviously, apply your best judgement. Remember, the goal here is to make the code base easier for humans to navigate and understand. Always keep that in mind when nudging others to comply.

The rules:

  1. All code should be formatted with gofmt -s.
  2. All code should pass the default levels of golint.
  3. All code should follow the guidelines covered in Effective Go and Go Code Review Comments.
  4. Comment the code. Tell us the why, the history and the context.
  5. Document all declarations and methods, even private ones. Declare expectations, caveats and anything else that may be important. If a type gets exported, having the comments already there will ensure it's ready.
  6. Variable name length should be proportional to its context and no longer. noCommaALongVariableNameLikeThisIsNotMoreClearWhenASimpleCommentWouldDo. In practice, short methods will have short variable names and globals will have longer names.
  7. No underscores in package names. If you need a compound name, step back, and re-examine why you need a compound name. If you still think you need a compound name, lose the underscore.
  8. No utils or helpers packages. If a function is not general enough to warrant its own package, it has not been written generally enough to be a part of a util package. Just leave it unexported and well-documented.
  9. All tests should run with go test and outside tooling should not be required. No, we don't need another unit testing framework. Assertion packages are acceptable if they provide real incremental value.
  10. Even though we call these "rules" above, they are actually just guidelines. Since you've read all the rules, you now know that.

If you are having trouble getting into the mood of idiomatic Go, we recommend reading through Effective Go. The Go Blog is also a great resource. Drinking the kool-aid is a lot easier than going thirsty.