python-cinderclient/HACKING.rst
Sean McGinnis d6530c48d9 Add doc linting to pep8 target
This adds doc8 to the pep8 job to lint the docs. Also fixes a few issues
it highlighted.

Change-Id: Id0f4b9bee1f6a0103ec581b20037a9b74201aaca
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
2020-06-05 14:53:12 +00:00

1.5 KiB

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.