Browse Source

Tidied up development environment instructions

Signed-off-by: Ben Firshman <[email protected]>
Ben Firshman 11 years ago
parent
commit
ea45715a50
1 changed files with 3 additions and 5 deletions
  1. 3 5
      CONTRIBUTING.md

+ 3 - 5
CONTRIBUTING.md

@@ -15,12 +15,10 @@ If you're looking contribute to [Fig](http://www.fig.sh/)
 but you're new to the project or maybe even to Python, here are the steps
 but you're new to the project or maybe even to Python, here are the steps
 that should get you started.
 that should get you started.
 
 
-1. Fork [https://github.com/docker/fig](https://github.com/docker/fig) to your username. kvz in this example.
-1. Clone your forked repository locally `git clone [email protected]:kvz/fig.git`.
+1. Fork [https://github.com/docker/fig](https://github.com/docker/fig) to your username.
+1. Clone your forked repository locally `git clone [email protected]:yourusername/fig.git`.
 1. Enter the local directory `cd fig`.
 1. Enter the local directory `cd fig`.
-1. Set up a development environment `python setup.py develop`. That will install the dependencies and set up a symlink from your `fig` executable to the checkout of the repo. So from any of your fig projects, `fig` now refers to your development project. Time to start hacking : )
-1. Works for you? Run the test suite via `./script/test` to verify it won't break other usecases.
-1. All good? Commit and push to GitHub, and submit a pull request.
+1. Set up a development environment by running `python setup.py develop`. This will install the dependencies and set up a symlink from your `fig` executable to the checkout of the repository. When you now run `fig` from anywhere on your machine, it will run your development version of Fig.
 
 
 ## Running the test suite
 ## Running the test suite