1.7 KiB
1.7 KiB
How To Contribute
Basics
- Our source code is hosted on StackForge GitHub, but please do not send pull requests there.
- Please follow usual OpenStack Gerrit Workflow to submit a patch.
- Update change log in README.rst on any significant change.
- It goes without saying that any code change should by accompanied by unit tests.
- Note the branch you're proposing changes to.
master
is the current focus of development, usestable/VERSION
for proposing an urgent fix, whereVERSION
is the current stable series. E.g. at the moment of writing the stable branch isstable/0.2
.
Development Environment
First of all, install tox utility. It's likely to be in your
distribution repositories under name of python-tox
.
Alternatively, you can install it from PyPI.
Next checkout and create environments:
git clone https://github.com/stackforge/ironic-discoverd.git
cd ironic-discoverd
tox
Repeat tox command each time you need to run tests. If you
don't have Python interpreter of one of supported versions (currently
2.7 and 3.3), use -e
flag to select only some environments,
e.g.
tox -e py27
Note
Support for Python 3 is highly experimental, stay with Python 2 for the production environment for now.
There is a simple functional test that involves fetching the ramdisk from Github:
tox -e func
Run the service with:
.tox/py27/bin/ironic-discoverd example.conf
Of course you may have to modify example.conf
to match
your OpenStack environment.