Improve contributing instructions #580
Conversation
Signed-off-by: Ben Firshman <[email protected]>
Signed-off-by: Ben Firshman <[email protected]>
It's less important than signing your work. Signed-off-by: Ben Firshman <[email protected]>
| 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. |
There was a problem hiding this comment.
Does python setup.py develop actually work? It did not work for me.
I've been using tox/virtualenv, it doesn't create the global fig executable (which I see as a plus), but if you're in the virtualenv , it will use your local checkout.
There was a problem hiding this comment.
It does work, I think. Works for me at least.
I think I'd much prefer some kind of wrapper script which ran the Fig development environment inside Docker. Something like...
#!/bin/bash
docker build -t fig .
docker run -v /var/run/docker.sock:/var/run/docker.sock fig bin/fig $@
There was a problem hiding this comment.
python setup.py develop works for me too (inside a virtualenv at least).
It'd be cool to be able to do it all in Docker and ditch virtualenv, but we'd need to figure out how to simultaneously be able to work on dependencies such as docker-py or dockerpty (both of which I needed to have local checkouts of in order to get TLS working, for example).
|
LGTM |
Improve contributing instructions
…ctions Improve contributing instructions Signed-off-by: Yuval Kohavi <[email protected]>
No description provided.