openstack/python-cinderclient
Code Issues Proposed changes
f0f8e6b5ab
python-cinderclient/HACKING.rst
stmcginnis f4b46766cb Update HACKING with current information 
Updates information about the current Reno release notes management.
Some stale or incorrect information was also removed.

Change-Id: I9ea25a538f2e75966f721f3c5b551d83487fb015
2016-01-15 08:27:54 -06:00

1.5 KiB
Raw Blame History

Cinder Client Style Commandments

Cinder Client Specific Commandments

General

  • Use 'raise' instead of 'raise e' to preserve original traceback or exception being reraised:

    except Exception as e:
    ...
    raise e  # BAD

except Exception:
    ...
    raise  # OKAY

Release Notes

  • Any patch that makes a change significant to the end consumer or deployer of an OpenStack environment should include a release note (new features, upgrade impacts, deprecated functionality, significant bug fixes, etc.)

  • Cinder Client uses Reno for release notes management. See the Reno Documentation for more details on its usage.

  • As a quick example, when adding a new shell command for Awesome Storage Feature, one could perform the following steps to include a release note for the new feature:

    $ tox -e venv -- reno new add-awesome-command $ vi releasenotes/notes/add-awesome-command-bb8bb8bb8bb8bb81.yaml

    Remove the extra template text from the release note and update the details so it looks something like:

    ---features:
    • Added shell command cinder be-awesome for Awesome Storage Feature.

  • Include the generated release notes file when submitting your patch for review.