Skip to content

Commit ca19f14

Browse files
committed
updated readme with driver contribution guidelines
Signed-off-by: Evan Hazlett <ejhazlett@gmail.com>
1 parent cbbf0ec commit ca19f14

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,25 @@ staging * digitalocean Running tcp://104.236.253.181:2376
4747

4848
Full documentation [is available here](https://docs.docker.com/machine/).
4949

50+
## Drivers
51+
Docker Machine has several included drivers that supports provisioning hosts
52+
in various providers. If you wish to contribute a driver, we ask the following
53+
to ensure we keep the driver in a consistent and stable state:
54+
55+
- Address issues filed against this driver in a timely manner
56+
- Review PRs for the driver
57+
- Be responsible for maintaining the infrastructure to run unit tests
58+
and integration tests on the new supported environment
59+
- Participate in a weekly driver maintainer meeting
60+
61+
If you can commit to those, the next step is to make sure the driver adheres
62+
to the [spec](https://github.com/docker/machine/blob/master/docs/DRIVER_SPEC.md).
63+
64+
Once you have created and tested the driver, you can open a PR.
65+
66+
Note: even if those are met does not guarantee a driver will be accepted.
67+
If you have questions, please do not hesitate to contact us on IRC.
68+
5069
## Contributing
5170

5271
[![GoDoc](https://godoc.org/github.com/docker/machine?status.png)](https://godoc.org/github.com/docker/machine)

0 commit comments

Comments
 (0)