Contributor Documentation

If you would like to contribute to the development of OpenStack, you must follow the steps in this page:

If you already have a good understanding of how the system works and your OpenStack accounts are set up, you can skip to the development workflow section of this documentation to learn how changes to OpenStack should be submitted for review via the Gerrit tool:

Pull requests submitted through GitHub will be ignored.

Bugs should be filed on Storyboard, not GitHub:

Testing changes in DIB images

Testing a local ironic-python-agent change in diskimage-builder images requires rebuilding an image with the following procedure.

  1. Make sure your changes are committed to your local repository. DIB needs to know a branch name to use (my-test-branch in the example below).

  2. Build an image as described in diskimage-builder images, providing a location of your local repository and the branch name, for example:

    DIB_REPOLOCATION_ironic_python_agent=/home/user/path/to/repo \
        DIB_REPOREF_ironic_python_agent=my-test-branch \
        ironic-python-agent-builder -o my-ipa --release 9-stream centos
    
  3. A similar process (with one additional variable) can be used for ironic-lib changes:

    DIB_REPOLOCATION_ironic_lib=/home/user/path/to/repo \
        DIB_REPOREF_ironic_lib=my-test-branch \
        IRONIC_LIB_FROM_SOURCE=true \
        ironic-python-agent-builder -o my-ipa --release 9-stream centos