Browse Source

Add in `git fork` syncing links

Signed-off-by: Mazz Mosley <[email protected]>
Mazz Mosley 10 years ago
parent
commit
098ec3dcaa
1 changed files with 3 additions and 2 deletions
  1. 3 2
      CONTRIBUTING.md

+ 3 - 2
CONTRIBUTING.md

@@ -22,8 +22,9 @@ 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 [email protected]:yourusername/compose.git`.
-3. Enter the local directory `cd compose`.
-4. Set up a development environment by running `python setup.py develop`. This
+3. You must [configure](https://help.github.com/articles/configuring-a-remote-for-a-fork/) a remote 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