diff options
| author | stmcginnis <sean.mcginnis@gmail.com> | 2016-01-09 17:58:18 -0600 |
|---|---|---|
| committer | Sean McGinnis <sean_mcginnis@dell.com> | 2016-01-15 08:27:54 -0600 |
| commit | f4b46766cbb18b0f1258c159f75f05ca353cb3f4 (patch) | |
| tree | 5d41f50534e64411594e5dca89c4f42361247b38 /HACKING.rst | |
| parent | 7476dbd8dcae331d63d034eb0d725e3edc1aee06 (diff) | |
| download | python-cinderclient-f4b46766cbb18b0f1258c159f75f05ca353cb3f4.tar.gz | |
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
Diffstat (limited to 'HACKING.rst')
| -rw-r--r-- | HACKING.rst | 64 |
1 files changed, 17 insertions, 47 deletions
diff --git a/HACKING.rst b/HACKING.rst index a48ac28..03844f1 100644 --- a/HACKING.rst +++ b/HACKING.rst @@ -20,58 +20,28 @@ General ... raise # OKAY -Text encoding +Release Notes ------------- -- All text within python code should be of type 'unicode'. - - WRONG: - - >>> s = 'foo' - >>> s - 'foo' - >>> type(s) - <type 'str'> - - RIGHT: - - >>> u = u'foo' - >>> u - u'foo' - >>> type(u) - <type 'unicode'> - -- Transitions between internal unicode and external strings should always - be immediately and explicitly encoded or decoded. +- 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.) -- All external text that is not explicitly encoded (database storage, - commandline arguments, etc.) should be presumed to be encoded as utf-8. +- Cinder Client uses Reno for release notes management. See the `Reno Documentation`_ + for more details on its usage. - WRONG: - - mystring = infile.readline() - myreturnstring = do_some_magic_with(mystring) - outfile.write(myreturnstring) - - RIGHT: - - mystring = infile.readline() - mytext = s.decode('utf-8') - returntext = do_some_magic_with(mytext) - returnstring = returntext.encode('utf-8') - outfile.write(returnstring) - -Release Notes -------------- -- Each patch should add an entry in the doc/source/index.rst file under - "MASTER". +.. _Reno Documentation: http://docs.openstack.org/developer/reno/ -- On each new release, the entries under "MASTER" will become the release notes - for that release, and "MASTER" will be cleared. +- 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: -- The format should match existing release notes. For example, a feature:: + $ tox -e venv -- reno new add-awesome-command + $ vi releasenotes/notes/add-awesome-command-bb8bb8bb8bb8bb81.yaml - * Add support for function foo + Remove the extra template text from the release note and update the details so it + looks something like: - Or a bug fix:: + --- + features: + - Added shell command `cinder be-awesome` for Awesome Storage Feature. - .. _1241941: http://bugs.launchpad.net/python-cinderclient/+bug/1241941 +- Include the generated release notes file when submitting your patch for review. |
