openstack/aodh
Code Issues Proposed changes
aodh/doc/source/contributing/source.rst
Doug Hellmann 1f9bce2609 extend developer documentation 
- Add information about the system architecture (modified
  from the wiki to reflect what was implemented).
- Add information about where we want contributions.
- Add information about how to sign up to participate in
  the project and how to be a part of the community.
- Add more detailed instructions for installing the development
  version from git.
- Add a placeholder for documenting the configuration options.
- Add instructions for running the tests after getting
  the source code.
- Add a glossary and index.

tags: DocImpact
bug 1006366

Change-Id: I8927c55e77cdd31804249d101575f9e174e6232d
Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
2012-07-05 14:46:37 -04: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/stackforge/ceilometer.git
$ cd ./ceilometer

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

    $ git remote add gerrit ssh://<username>@review.stackforge.org:29418/stackforge/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.