2013-03-29 00:04:21 +00:00
|
|
|
# Contributing to Docker
|
|
|
|
|
2013-11-11 05:15:26 +00:00
|
|
|
Want to hack on Docker? Awesome! Here are instructions to get you
|
|
|
|
started. They are probably not perfect, please let us know if anything
|
|
|
|
feels wrong or incomplete.
|
2013-03-29 00:04:21 +00:00
|
|
|
|
2013-11-27 18:41:20 +00:00
|
|
|
## Reporting Issues
|
|
|
|
|
|
|
|
When reporting [issues](https://github.com/dotcloud/docker/issues)
|
2014-02-06 09:06:25 +00:00
|
|
|
on GitHub please include your host OS (Ubuntu 12.04, Fedora 19, etc),
|
|
|
|
the output of `uname -a` and the output of `docker version` along with
|
|
|
|
the output of `docker info`. Please include the steps required to reproduce
|
|
|
|
the problem if possible and applicable.
|
2013-11-27 18:41:20 +00:00
|
|
|
This information will help us review and fix your issue faster.
|
|
|
|
|
2013-10-08 22:48:19 +00:00
|
|
|
## Build Environment
|
|
|
|
|
2013-11-11 05:15:26 +00:00
|
|
|
For instructions on setting up your development environment, please
|
|
|
|
see our dedicated [dev environment setup
|
|
|
|
docs](http://docs.docker.io/en/latest/contributing/devenvironment/).
|
2013-10-08 22:48:19 +00:00
|
|
|
|
2013-03-29 00:04:21 +00:00
|
|
|
## Contribution guidelines
|
|
|
|
|
|
|
|
### Pull requests are always welcome
|
|
|
|
|
|
|
|
We are always thrilled to receive pull requests, and do our best to
|
|
|
|
process them as fast as possible. Not sure if that typo is worth a pull
|
|
|
|
request? Do it! We will appreciate it.
|
|
|
|
|
|
|
|
If your pull request is not accepted on the first try, don't be
|
|
|
|
discouraged! If there's a problem with the implementation, hopefully you
|
|
|
|
received feedback on what to improve.
|
|
|
|
|
|
|
|
We're trying very hard to keep Docker lean and focused. We don't want it
|
|
|
|
to do everything for everybody. This means that we might decide against
|
|
|
|
incorporating a new feature. However, there might be a way to implement
|
|
|
|
that feature *on top of* docker.
|
|
|
|
|
|
|
|
### Discuss your design on the mailing list
|
|
|
|
|
|
|
|
We recommend discussing your plans [on the mailing
|
2013-08-24 17:26:54 +00:00
|
|
|
list](https://groups.google.com/forum/?fromgroups#!forum/docker-dev)
|
2013-03-29 00:04:21 +00:00
|
|
|
before starting to code - especially for more ambitious contributions.
|
|
|
|
This gives other contributors a chance to point you in the right
|
|
|
|
direction, give feedback on your design, and maybe point out if someone
|
|
|
|
else is working on the same thing.
|
|
|
|
|
|
|
|
### Create issues...
|
|
|
|
|
2014-01-10 02:56:05 +00:00
|
|
|
Any significant improvement should be documented as [a GitHub
|
2013-03-29 00:04:21 +00:00
|
|
|
issue](https://github.com/dotcloud/docker/issues) before anybody
|
|
|
|
starts working on it.
|
|
|
|
|
|
|
|
### ...but check for existing issues first!
|
|
|
|
|
|
|
|
Please take a moment to check that an issue doesn't already exist
|
|
|
|
documenting your bug report or improvement proposal. If it does, it
|
|
|
|
never hurts to add a quick "+1" or "I have this problem too". This will
|
|
|
|
help prioritize the most common problems and requests.
|
|
|
|
|
|
|
|
### Conventions
|
|
|
|
|
|
|
|
Fork the repo and make changes on your fork in a feature branch:
|
|
|
|
|
2013-04-01 16:28:54 +00:00
|
|
|
- If it's a bugfix branch, name it XXX-something where XXX is the number of the
|
|
|
|
issue
|
|
|
|
- If it's a feature branch, create an enhancement issue to announce your
|
|
|
|
intentions, and name it XXX-something where XXX is the number of the issue.
|
2013-03-29 00:04:21 +00:00
|
|
|
|
2013-04-01 16:28:54 +00:00
|
|
|
Submit unit tests for your changes. Go has a great test framework built in; use
|
|
|
|
it! Take a look at existing tests for inspiration. Run the full test suite on
|
|
|
|
your branch before submitting a pull request.
|
2013-03-29 00:04:21 +00:00
|
|
|
|
2013-10-15 22:52:21 +00:00
|
|
|
Update the documentation when creating or modifying features. Test
|
|
|
|
your documentation changes for clarity, concision, and correctness, as
|
2013-11-26 15:13:39 +00:00
|
|
|
well as a clean documentation build. See ``docs/README.md`` for more
|
2013-10-15 22:52:21 +00:00
|
|
|
information on building the docs and how docs get released.
|
2013-03-29 00:04:21 +00:00
|
|
|
|
2013-04-01 16:28:54 +00:00
|
|
|
Write clean code. Universally formatted code promotes ease of writing, reading,
|
|
|
|
and maintenance. Always run `go fmt` before committing your changes. Most
|
|
|
|
editors have plugins that do this automatically, and there's also a git
|
|
|
|
pre-commit hook:
|
2013-03-29 00:04:21 +00:00
|
|
|
|
2013-04-01 16:28:54 +00:00
|
|
|
```
|
|
|
|
curl -o .git/hooks/pre-commit https://raw.github.com/edsrzf/gofmt-git-hook/master/fmt-check && chmod +x .git/hooks/pre-commit
|
|
|
|
```
|
2013-03-29 00:04:21 +00:00
|
|
|
|
|
|
|
Pull requests descriptions should be as clear as possible and include a
|
2013-04-01 16:28:54 +00:00
|
|
|
reference to all the issues that they address.
|
|
|
|
|
2014-03-05 17:33:18 +00:00
|
|
|
Pull requests must not contain commits from other users or branches.
|
2014-02-06 09:06:25 +00:00
|
|
|
|
2013-04-01 16:28:54 +00:00
|
|
|
Code review comments may be added to your pull request. Discuss, then make the
|
|
|
|
suggested modifications and push additional commits to your feature branch. Be
|
|
|
|
sure to post a comment after pushing. The new commits will show up in the pull
|
|
|
|
request automatically, but the reviewers will not be notified unless you
|
|
|
|
comment.
|
|
|
|
|
|
|
|
Before the pull request is merged, make sure that you squash your commits into
|
|
|
|
logical units of work using `git rebase -i` and `git push -f`. After every
|
|
|
|
commit the test suite should be passing. Include documentation changes in the
|
|
|
|
same commit so that a revert would remove all traces of the feature or fix.
|
|
|
|
|
|
|
|
Commits that fix or close an issue should include a reference like `Closes #XXX`
|
|
|
|
or `Fixes #XXX`, which will automatically close the issue when merged.
|
|
|
|
|
|
|
|
Add your name to the AUTHORS file, but make sure the list is sorted and your
|
|
|
|
name and email address match your git configuration. The AUTHORS file is
|
|
|
|
regenerated occasionally from the git commit history, so a mismatch may result
|
|
|
|
in your changes being overwritten.
|
2013-05-29 02:39:09 +00:00
|
|
|
|
2014-02-11 00:10:50 +00:00
|
|
|
### Merge approval
|
|
|
|
|
|
|
|
Docker maintainers use LGTM (looks good to me) in comments on the code review
|
|
|
|
to indicate acceptance.
|
|
|
|
|
|
|
|
A change requires LGTMs from an absolute majority of the maintainers of each
|
|
|
|
component affected. For example, if a change affects docs/ and registry/, it
|
|
|
|
needs an absolute majority from the maintainers of docs/ AND, separately, an
|
2014-03-02 15:54:43 +00:00
|
|
|
absolute majority of the maintainers of registry.
|
2014-02-11 00:10:50 +00:00
|
|
|
|
|
|
|
For more details see [MAINTAINERS.md](hack/MAINTAINERS.md)
|
|
|
|
|
Add Developer Certificate of Origin Text
We purposely chose to license Docker under the Apache 2.0 license. This is a well-known
license, which is popular for its permissive and flexible properties, while still
encouraging a collaborative community. It also makes certain representations with regard
to contributions, and the rights given to contributors, the project, people who use Docker,
people who modify Docker, etc.
This approach to contributions is inspired by the popular Linux Developer
"Certificate of Origin". This approach makes it simple for new contributors to get started,
and avoids bureaucracy in tracking contributions and contributors.
To indicate accordance, each individual contribution to the Project is signed off by the
developer, using his or her real name, email address, and github handle in the format below:
Docker-DCO-1.0-Signed-off-by: Joe Smith <joe.smith@email.com>
2013-10-04 21:17:59 +00:00
|
|
|
### Sign your work
|
2013-10-10 20:25:59 +00:00
|
|
|
|
Add Developer Certificate of Origin Text
We purposely chose to license Docker under the Apache 2.0 license. This is a well-known
license, which is popular for its permissive and flexible properties, while still
encouraging a collaborative community. It also makes certain representations with regard
to contributions, and the rights given to contributors, the project, people who use Docker,
people who modify Docker, etc.
This approach to contributions is inspired by the popular Linux Developer
"Certificate of Origin". This approach makes it simple for new contributors to get started,
and avoids bureaucracy in tracking contributions and contributors.
To indicate accordance, each individual contribution to the Project is signed off by the
developer, using his or her real name, email address, and github handle in the format below:
Docker-DCO-1.0-Signed-off-by: Joe Smith <joe.smith@email.com>
2013-10-04 21:17:59 +00:00
|
|
|
The sign-off is a simple line at the end of the explanation for the
|
|
|
|
patch, which certifies that you wrote it or otherwise have the right to
|
|
|
|
pass it on as an open-source patch. The rules are pretty simple: if you
|
|
|
|
can certify the below:
|
|
|
|
|
|
|
|
```
|
2014-01-27 20:16:45 +00:00
|
|
|
Docker Developer Certificate of Origin 1.1
|
Add Developer Certificate of Origin Text
We purposely chose to license Docker under the Apache 2.0 license. This is a well-known
license, which is popular for its permissive and flexible properties, while still
encouraging a collaborative community. It also makes certain representations with regard
to contributions, and the rights given to contributors, the project, people who use Docker,
people who modify Docker, etc.
This approach to contributions is inspired by the popular Linux Developer
"Certificate of Origin". This approach makes it simple for new contributors to get started,
and avoids bureaucracy in tracking contributions and contributors.
To indicate accordance, each individual contribution to the Project is signed off by the
developer, using his or her real name, email address, and github handle in the format below:
Docker-DCO-1.0-Signed-off-by: Joe Smith <joe.smith@email.com>
2013-10-04 21:17:59 +00:00
|
|
|
|
2014-01-09 18:06:48 +00:00
|
|
|
By making a contribution to the Docker Project ("Project"), I represent and
|
|
|
|
warrant that:
|
|
|
|
|
|
|
|
a. The contribution was created in whole or in part by me and I have the right
|
|
|
|
to submit the contribution on my own behalf or on behalf of a third party who
|
|
|
|
has authorized me to submit this contribution to the Project; or
|
|
|
|
|
|
|
|
b. The contribution is based upon previous work that, to the best of my
|
|
|
|
knowledge, is covered under an appropriate open source license and I have the
|
|
|
|
right and authorization to submit that work with modifications, whether
|
|
|
|
created in whole or in part by me, under the same open source license (unless
|
|
|
|
I am permitted to submit under a different license) that I have identified in
|
|
|
|
the contribution; or
|
|
|
|
|
|
|
|
c. The contribution was provided directly to me by some other person who
|
|
|
|
represented and warranted (a) or (b) and I have not modified it.
|
|
|
|
|
|
|
|
d. I understand and agree that this Project and the contribution are publicly
|
|
|
|
known and that a record of the contribution (including all personal
|
|
|
|
information I submit with it, including my sign-off record) is maintained
|
|
|
|
indefinitely and may be redistributed consistent with this Project or the open
|
|
|
|
source license(s) involved.
|
Add Developer Certificate of Origin Text
We purposely chose to license Docker under the Apache 2.0 license. This is a well-known
license, which is popular for its permissive and flexible properties, while still
encouraging a collaborative community. It also makes certain representations with regard
to contributions, and the rights given to contributors, the project, people who use Docker,
people who modify Docker, etc.
This approach to contributions is inspired by the popular Linux Developer
"Certificate of Origin". This approach makes it simple for new contributors to get started,
and avoids bureaucracy in tracking contributions and contributors.
To indicate accordance, each individual contribution to the Project is signed off by the
developer, using his or her real name, email address, and github handle in the format below:
Docker-DCO-1.0-Signed-off-by: Joe Smith <joe.smith@email.com>
2013-10-04 21:17:59 +00:00
|
|
|
```
|
|
|
|
|
2014-01-08 00:17:15 +00:00
|
|
|
then you just add a line to every git commit message:
|
Add Developer Certificate of Origin Text
We purposely chose to license Docker under the Apache 2.0 license. This is a well-known
license, which is popular for its permissive and flexible properties, while still
encouraging a collaborative community. It also makes certain representations with regard
to contributions, and the rights given to contributors, the project, people who use Docker,
people who modify Docker, etc.
This approach to contributions is inspired by the popular Linux Developer
"Certificate of Origin". This approach makes it simple for new contributors to get started,
and avoids bureaucracy in tracking contributions and contributors.
To indicate accordance, each individual contribution to the Project is signed off by the
developer, using his or her real name, email address, and github handle in the format below:
Docker-DCO-1.0-Signed-off-by: Joe Smith <joe.smith@email.com>
2013-10-04 21:17:59 +00:00
|
|
|
|
2014-01-09 16:47:03 +00:00
|
|
|
Docker-DCO-1.1-Signed-off-by: Joe Smith <joe.smith@email.com> (github: github_handle)
|
Add Developer Certificate of Origin Text
We purposely chose to license Docker under the Apache 2.0 license. This is a well-known
license, which is popular for its permissive and flexible properties, while still
encouraging a collaborative community. It also makes certain representations with regard
to contributions, and the rights given to contributors, the project, people who use Docker,
people who modify Docker, etc.
This approach to contributions is inspired by the popular Linux Developer
"Certificate of Origin". This approach makes it simple for new contributors to get started,
and avoids bureaucracy in tracking contributions and contributors.
To indicate accordance, each individual contribution to the Project is signed off by the
developer, using his or her real name, email address, and github handle in the format below:
Docker-DCO-1.0-Signed-off-by: Joe Smith <joe.smith@email.com>
2013-10-04 21:17:59 +00:00
|
|
|
|
|
|
|
using your real name (sorry, no pseudonyms or anonymous contributions.)
|
|
|
|
|
2014-01-08 00:17:15 +00:00
|
|
|
One way to automate this, is customise your get ``commit.template`` by adding
|
2014-01-10 02:56:05 +00:00
|
|
|
a ``prepare-commit-msg`` hook to your docker checkout:
|
2014-01-08 00:17:15 +00:00
|
|
|
|
|
|
|
```
|
2014-01-10 02:56:05 +00:00
|
|
|
curl -o .git/hooks/prepare-commit-msg https://raw.github.com/dotcloud/docker/master/contrib/prepare-commit-msg.hook && chmod +x .git/hooks/prepare-commit-msg
|
2014-02-04 05:29:47 +00:00
|
|
|
```
|
2014-01-08 00:17:15 +00:00
|
|
|
|
2014-01-10 02:56:05 +00:00
|
|
|
* Note: the above script expects to find your GitHub user name in ``git config --get github.user``
|
2014-01-08 00:17:15 +00:00
|
|
|
|
2014-03-02 15:54:43 +00:00
|
|
|
#### Small patch exception
|
|
|
|
|
|
|
|
There are several exceptions to the signing requirement. Currently these are:
|
2013-10-10 20:25:59 +00:00
|
|
|
|
2014-03-02 15:54:43 +00:00
|
|
|
* Your patch fixes spelling or grammar errors.
|
|
|
|
* Your patch is a single line change to documentation.
|
2013-10-10 20:25:59 +00:00
|
|
|
|
2014-03-02 15:54:43 +00:00
|
|
|
If you have any questions, please refer to the FAQ in the [docs](http://docs.docker.io)
|
2013-05-29 02:39:09 +00:00
|
|
|
|
|
|
|
### How can I become a maintainer?
|
|
|
|
|
2013-05-29 04:26:42 +00:00
|
|
|
* Step 1: learn the component inside out
|
|
|
|
* Step 2: make yourself useful by contributing code, bugfixes, support etc.
|
|
|
|
* Step 3: volunteer on the irc channel (#docker@freenode)
|
2014-02-05 00:15:22 +00:00
|
|
|
* Step 4: propose yourself at a scheduled docker meeting in #docker-dev
|
2013-05-29 02:39:09 +00:00
|
|
|
|
|
|
|
Don't forget: being a maintainer is a time investment. Make sure you will have time to make yourself available.
|
|
|
|
You don't have to be a maintainer to make a difference on the project!
|
|
|
|
|