Difference between revisions of "Cinder/Contributing"
(Adding initial cinder contribute doc, stolen from ceilometer contribute.) |
(adding links to doc repos) |
||
| Line 9: | Line 9: | ||
== Possible tasks == | == Possible tasks == | ||
=== Update documentation === | === Update documentation === | ||
| − | + | Try following the [http://docs.openstack.org/grizzly/openstack-block-storage/admin/content/ documentation to set-up and configuring Cinder] 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. | + | 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 [https://github.com/openstack/openstack-manuals fixed and updated]. |
| − | To update the documentation, the best way is to send a patch. But notifying the team via the [[MailingLists#Development_List|development mailing list]] or via IRC is fine too. | + | To update the documentation, the best way is to [[Documentation/HowTo|send a patch]]. But notifying the team via the [[MailingLists#Development_List|development mailing list]] or via IRC is fine too. |
=== Close old fixed bugs === | === Close old fixed bugs === | ||
Revision as of 17:16, 10 July 2013
Contents
Contributing to Cinder
The project team hangs out on Freenode in the #openstack-cinder 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 [cinder].
The project team officially meets once a week, see Cinder's Meeting Agenda
Setting-up cinder via devstack
The easiest way to develop on Cinder is to use devstack.
Possible tasks
Update documentation
Try following the documentation to set-up and configuring Cinder 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 cinder and for python-cinderclient.
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.
