diff options
| author | Matthew Iversen <teh.ivo@gmail.com> | 2014-06-15 07:12:45 +1000 |
|---|---|---|
| committer | Matthew Iversen <teh.ivo@gmail.com> | 2014-06-15 07:12:45 +1000 |
| commit | 5743a97cabf3fce3fca8fe24c228cc7db9e3581f (patch) | |
| tree | 9b7e78bd441e502a89615d51ad7a1bdf3699bb5e /CONTRIBUTING.rst | |
| parent | 1ddc648733b157c9fdbbe003ce919f310138ba03 (diff) | |
| download | virtualenv-5743a97cabf3fce3fca8fe24c228cc7db9e3581f.tar.gz | |
Update contributing guide
Diffstat (limited to 'CONTRIBUTING.rst')
| -rw-r--r-- | CONTRIBUTING.rst | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 4eb6da7..3bee582 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,16 +1,21 @@ virtualenv ========== -See docs/index.txt for user documentation. +See docs/index.rst for user documentation. Contributor notes ----------------- -* virtualenv is designed to work on python 2 and 3 with a single code base. +* virtualenv is designed to work on python 2 and 3 with a single code base. Use Python 3 print-function syntax, and always use sys.exc_info()[1] inside the `except` block to get at exception objects. -* virtualenv uses git-flow_ to `coordinate development`_. +* virtualenv uses git-flow_ to `coordinate development`_. The latest stable + version should exist on the master branch, and new work should be + integrated to development. + +* All changes to files inside virtualenv_embedded should be integrated to + ``virtualenv.py`` with ``bin/rebuild-script.py``. .. _git-flow: https://github.com/nvie/gitflow .. _coordinate development: http://nvie.com/posts/a-successful-git-branching-model/ |