openstack/deb-ceilometer
Code Issues Proposed changes
c6a093511c
deb-ceilometer/doc/source/contributing/source.rst
Julien Danjou 325715c01f doc: rename stackforge to openstack 
Change-Id: I31b0b7107742950e82473a9e776461994ab342f7
Signed-off-by: Julien Danjou <julien@danjou.info>
2012-11-13 10:08:41 +01:00

2.1 KiB
Raw Blame History

Working with the Source

Setting up a Development Sandbox

  1. Set up a server or virtual machine to run OpenStack using devstack.

  2. Clone the ceilometer project to the machine:

    $ cd /opt/stack
$ git clone https://github.com/openstack/ceilometer.git
$ cd ./ceilometer

  3. Once this is done, you need to setup the review process:

    $ git remote add gerrit ssh://<username>@review.openstack.org:29418/openstack/ceilometer.git

  4. If you are preparing a patch, create a topic branch and switch to it before making any changes:

    $ git checkout -b TOPIC-BRANCH

Running the Tests

Ceiloemter includes an extensive set of automated unit tests which are run through tox.

  1. Install tox:

    $ sudo pip install tox

  2. Install the test dependencies:

    $ sudo pip install -r /opt/stack/ceilometer/tools/test-requires

  3. Run the unit and code-style tests:

    $ cd /opt/stack/ceilometer
$ tox -e py27,pep8

Code Reviews

Ceilometer uses the OpenStack review process for all code and developer documentation contributions. Code reviews are managed through gerrit.