mirror of
https://github.com/docker/compose.git
synced 2025-04-08 17:05:13 +02:00
9ddb7f3c90
As per [their blog post of the 27th April](https://blog.readthedocs.com/securing-subdomains/) ‘Securing subdomains’: > Starting today, Read the Docs will start hosting projects from subdomains on the domain readthedocs.io, instead of on readthedocs.org. This change addresses some security concerns around site cookies while hosting user generated data on the same domain as our dashboard. Test Plan: Manually visited all the links I’ve modified. Signed-off-by: Adam Chainz <adam@adamj.eu>
75 lines
3.3 KiB
Markdown
75 lines
3.3 KiB
Markdown
# Contributing to Compose
|
|
|
|
Compose is a part of the Docker project, and follows the same rules and
|
|
principles. Take a read of [Docker's contributing guidelines](https://github.com/docker/docker/blob/master/CONTRIBUTING.md)
|
|
to get an overview.
|
|
|
|
## TL;DR
|
|
|
|
Pull requests will need:
|
|
|
|
- Tests
|
|
- Documentation
|
|
- [To be signed off](https://github.com/docker/docker/blob/master/CONTRIBUTING.md#sign-your-work)
|
|
- A logical series of [well written commits](https://github.com/alphagov/styleguides/blob/master/git.md)
|
|
|
|
## 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](https://github.com/docker/compose)
|
|
to your username.
|
|
2. Clone your forked repository locally `git clone git@github.com:yourusername/compose.git`.
|
|
3. You must [configure a remote](https://help.github.com/articles/configuring-a-remote-for-a-fork/) for your fork so that you can [sync changes you make](https://help.github.com/articles/syncing-a-fork/) with the original repository.
|
|
4. Enter the local directory `cd compose`.
|
|
5. 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.
|
|
|
|
## Install pre-commit hooks
|
|
|
|
This step is optional, but recommended. Pre-commit hooks will run style checks
|
|
and in some cases fix style issues for you, when you commit code.
|
|
|
|
Install the git pre-commit hooks using [tox](https://tox.readthedocs.io) by
|
|
running `tox -e pre-commit` or by following the
|
|
[pre-commit install guide](http://pre-commit.com/#install).
|
|
|
|
To run the style checks at any time run `tox -e pre-commit`.
|
|
|
|
## Submitting a pull request
|
|
|
|
See Docker's [basic contribution workflow](https://docs.docker.com/opensource/workflow/make-a-contribution/#the-basic-contribution-workflow) for a guide on how to submit a pull request for code or documentation.
|
|
|
|
## Running the test suite
|
|
|
|
Use the test script to run linting checks and then the full test suite against
|
|
different Python interpreters:
|
|
|
|
$ script/test/default
|
|
|
|
Tests are run against a Docker daemon inside a container, so that we can test
|
|
against multiple Docker versions. By default they'll run against only the latest
|
|
Docker version - set the `DOCKER_VERSIONS` environment variable to "all" to run
|
|
against all supported versions:
|
|
|
|
$ DOCKER_VERSIONS=all script/test/default
|
|
|
|
Arguments to `script/test/default` are passed through to the `tox` executable, so
|
|
you can specify a test directory, file, module, class or method:
|
|
|
|
$ script/test/default tests/unit
|
|
$ script/test/default tests/unit/cli_test.py
|
|
$ script/test/default tests/unit/config_test.py::ConfigTest
|
|
$ script/test/default tests/unit/config_test.py::ConfigTest::test_load
|
|
|
|
## Finding things to work on
|
|
|
|
We use a [ZenHub board](https://www.zenhub.io/) to keep track of specific things we are working on and planning to work on. If you're looking for things to work on, stuff in the backlog is a great place to start.
|
|
|
|
For more information about our project planning, take a look at our [GitHub wiki](https://github.com/docker/compose/wiki).
|