compose/CONTRIBUTING.md

Contributing to Compose

TL;DR

Pull requests will need:

• Tests
• Documentation
• To be signed off
• A logical series of well written commits

Development environment

If you're looking contribute to Compose but you're new to the project or maybe even to Python, here are the steps that should get you started.

1. Fork https://github.com/docker/compose to your username.
2. Clone your forked repository locally git clone git@github.com:yourusername/compose.git.
3. Enter the local directory cd compose.
4. Set up a development environment by running python setup.py develop. This will install the dependencies and set up a symlink from your docker-compose executable to the checkout of the repository. When you now run docker-compose from anywhere on your machine, it will run your development version of Compose.

Running the test suite

$ script/test

Sign your work

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 (from developercertificate.org):

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; 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 under that license 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), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

then you just add a line saying

Signed-off-by: Random J Developer <random@developer.example.org>

using your real name (sorry, no pseudonyms or anonymous contributions.)

The easiest way to do this is to use the --signoff flag when committing. E.g.:

$ git commit --signoff

Building binaries

Linux:

$ script/build-linux

OS X:

$ script/build-osx

Note that this only works on Mountain Lion, not Mavericks, due to a bug in PyInstaller.

Release process

1. Open pull request that:

• Updates version in compose/__init__.py
• Updates version in docs/install.md
• Adds release notes to CHANGES.md

2. Create unpublished GitHub release with release notes

3. Build Linux version on any Docker host with script/build-linux and attach to release

4. Build OS X version on Mountain Lion with script/build-osx and attach to release as docker-compose-Darwin-x86_64 and docker-compose-Linux-x86_64.

5. Publish GitHub release, creating tag

6. Update website with script/deploy-docs

7. Upload PyPi package

   $ git checkout $VERSION $ python setup.py sdist upload