Jump to: navigation, search

Difference between revisions of "Ceilometer/Contributing"

 
m (Text replace - "__NOTOC__" to "")
Line 1: Line 1:
__NOTOC__
+
 
 
= Contributing to Ceilometer =
 
= Contributing to Ceilometer =
 
The developer documentation is starting to take shape within the source and is also published at http://docs.openstack.org/developer/ceilometer/ in a more friendly format.
 
The developer documentation is starting to take shape within the source and is also published at http://docs.openstack.org/developer/ceilometer/ in a more friendly format.

Revision as of 23:31, 17 February 2013

Contributing to Ceilometer

The developer documentation is starting to take shape within the source and is also published at http://docs.openstack.org/developer/ceilometer/ in a more friendly format.

The project team hangs out on Freenode in the #openstack-metering channel, feel free to drop by and stay as long as you want to discuss your future implementation. We use the OpenStack General Mailing List for our email discussions tagging the the subject with [metering].

The project team officially meets once a week, see Ceilometer's Meeting Agenda

Setting-up Ceilometer via devstack

The easiest way to develop on Ceilometer is to use devstack.

Edit your localrc file and add these lines to enable ceilometer:


#!highlight bash
enable_service ceilometer-api
enable_service ceilometer-collector
enable_service ceilometer-acentral
enable_service ceilometer-acompute


Possible tasks

Update documentation

Trying following the documentation to set-up and configuring Ceilometer to see if the documention is not wrong or out-dated would be a good first step. Once everything's working, the next step would be to read the rest of the documentation to see if everything that's written is still true. Anything that's not clear or might be missing should be fixed and updated.

To update the documentation, the best way is to send a patch. But notifying the team via the development mailing list or via IRC is fine too!

Close old fixed bugs

Old bugs are nasty. Even when they are long dead, they clog bug views and render the lists unusable. Just look at old bugs and check if they still apply! If they don't, close them as FixReleased (if you can pinpoint when they were fixed) or Invalid (if you can't).

Fix bugs

The best thing you can do is to kill a living bug. Just look at the list of Confirmed or Triaged and pick your target. Submit a change that fixes it. Ask for review help on the channel.

Review patches

You can review patches on the Gerrit platform for ceilometer and for python-ceilometerclient.

Triage incoming bugs

It's sometimes hard to distinguish fresh bugs from false alarms. You can help by using your expertise or reproduction skills on New bugs. If you can confirm the issue, set the bug to Confirmed. If you can fix it, read the previous entry. If you need more info from the reporter, set it to Incomplete. And if it happens to not really be valid, set it to Invalid!

You can read more information about how to do bug triaging for OpenStack.