swift/CONTRIBUTING.md
John Dickinson fdcd20f2b6 added docs on specs workflow to CONTRIBUTING.md
Change-Id: Id83d1da2a7a594a07fc5332b918539b3728e101b
2014-11-07 22:21:02 +11:00

1.7 KiB

If you would like to contribute to the development of OpenStack, you must follow the steps in the "If you're a developer" section of this page: http://wiki.openstack.org/HowToContribute

Once those steps have been completed, changes to OpenStack should be submitted for review via the Gerrit tool, following the workflow documented at http://wiki.openstack.org/GerritWorkflow.

Gerrit is the review system used in the OpenStack projects. We're sorry, but we won't be able to respond to pull requests submitted through GitHub.

Bugs should be filed on Launchpad, not in GitHub's issue tracker.

Recommended workflow

  • Set up a Swift All-In-One VM.

  • Make your changes. Docs and tests for your patch must land before or with your patch.

  • Run unit tests, functional tests, probe tests ./.unittests ./.functests ./.probetests

  • Run tox (no command-line args needed)

  • git review

Specs

The swift-specs repo can be used for collaborative design work before a feature is implemented.

Openstack's gerrit system is used to collaborate on the design spec. Once approved Openstack provides a doc site to easily read these specs

A spec is needed for more impactful features. Coordinating a feature between many devs (especially across companies) is a great example of when a spec is needed. If you are unsure if a spec document is needed, please feel free to ask in #openstack-swift on freenode IRC.