tyler.durden/compose
1
0
Fork 0
mirror of https://github.com/docker/compose.git synced 2025-07-23 05:34:36 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #580 from bfirsh/improve-contributing-instructions

Browse Source 
Improve contributing instructions
This commit is contained in:
Aanand Prasad 2014-10-24 11:43:14 +01:00
commit a83876da09
1 changed files with 23 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
CONTRIBUTING.md
View File

@ -1,34 +1,29 @@
# Contributing to Fig # Contributing to Fig
## TL;DR
Pull requests will need:
- Tests
- Documentation
- [To be signed off](#sign-your-work)
- A logical series of [well written commits](https://github.com/alphagov/styleguides/blob/master/git.md)
## Development environment ## Development environment
If you're looking contribute to [Fig](http://www.fig.sh/) 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. Fork [https://github.com/docker/fig](https://github.com/docker/fig) to your username.
1. Clone your forked repository locally `git clone git@github.com:kvz/fig.git`. 1. Clone your forked repository locally `git clone git@github.com: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. 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.
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.
## Running the test suite ## Running the test suite
$ script/test $ script/test
## 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](http://www.pyinstaller.org/ticket/807).
## Sign your work ## Sign your work
The sign-off is a simple line at the end of the explanation for the The sign-off is a simple line at the end of the explanation for the
@ -73,6 +68,17 @@ The easiest way to do this is to use the `--signoff` flag when committing. E.g.:
$ git commit --signoff $ 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](http://www.pyinstaller.org/ticket/807).
## Release process ## Release process