diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6b875d6901..26ce62b5c0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ Want to hack on Docker? Awesome! We have a contributor's guide that explains [setting up a Docker development environment and the contribution process](https://docs.docker.com/opensource/project/who-written-for/). -![Contributors guide](docs/static_files/contributors.png) +[![Contributors guide](docs/static_files/contributors.png)](https://docs.docker.com/opensource/project/who-written-for/) This page contains information about reporting issues as well as some tips and guidelines useful to experienced open source contributors. Finally, make sure @@ -58,51 +58,11 @@ When sending lengthy log-files, consider posting them as a gist (https://gist.gi Don't forget to remove sensitive data from your logfiles before posting (you can replace those parts with "REDACTED"). -**Issue Report Template**: - -``` -Description of problem: - - -`docker version`: - - -`docker info`: - - -`uname -a`: - - -Environment details (AWS, VirtualBox, physical, etc.): - - -How reproducible: - - -Steps to Reproduce: -1. -2. -3. - - -Actual Results: - - -Expected Results: - - -Additional info: - - - -``` - - -##Quick contribution tips and guidelines +## Quick contribution tips and guidelines This section gives the experienced contributor some tips and guidelines. -###Pull requests are always welcome +### Pull requests are always welcome Not sure if that typo is worth a pull request? Found a bug and know how to fix it? Do it! We will appreciate it. Any significant improvement should be @@ -132,6 +92,14 @@ However, there might be a way to implement that feature *on top of* Docker. + + + + - + @@ -308,10 +276,6 @@ Use your real name (sorry, no pseudonyms or anonymous contributions.) If you set your `user.name` and `user.email` git configs, you can sign your commit automatically with `git commit -s`. -Note that the old-style `Docker-DCO-1.1-Signed-off-by: ...` format is still -accepted, so there is no need to update outstanding pull requests to the new -format right away, but please do adjust your processes for future contributions. - ### How can I become a maintainer? The procedures for adding new maintainers are explained in the @@ -431,6 +395,6 @@ The rules: 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](http://golang.org/doc/effective_go.html). The -[Go Blog](http://blog.golang.org/) is also a great resource. Drinking the +reading through [Effective Go](https://golang.org/doc/effective_go.html). The +[Go Blog](https://blog.golang.org) is also a great resource. Drinking the kool-aid is a lot easier than going thirsty.
Forums + A public forum for users to discuss questions and explore current design patterns and + best practices about Docker and related projects in the Docker Ecosystem. To participate, + just log in with your Docker Hub account on https://forums.docker.com. +
Internet Relay Chat (IRC) @@ -142,19 +110,19 @@ However, there might be a way to implement that feature *on top of* Docker. IRC is a rich chat protocol but it can overwhelm new users. You can search our chat archives.

- Read our IRC quickstart guide for an easy way to get started. +

+ Read our IRC quickstart guide + for an easy way to get started. +

Google GroupsGoogle Group - There are two groups. - Docker-user - is for people using Docker containers. The docker-dev - group is for contributors and other people contributing to the Docker - project. - You can join them without an google account by sending an email to e.g. "docker-user+subscribe@googlegroups.com". + group is for contributors and other people contributing to the Docker project. + You can join them without an google account by sending an email to + docker-dev+subscribe@googlegroups.com. After receiving the join-request message, you can simply reply to that to confirm the subscribtion.