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
This commit is contained in:
		
				
					committed by
					
						
						Sean McGinnis
					
				
			
			
				
	
			
			
			
						parent
						
							7476dbd8dc
						
					
				
				
					commit
					f4b46766cb
				
			
							
								
								
									
										66
									
								
								HACKING.rst
									
									
									
									
									
								
							
							
						
						
									
										66
									
								
								HACKING.rst
									
									
									
									
									
								
							@@ -20,58 +20,28 @@ General
 | 
				
			|||||||
        ...
 | 
					        ...
 | 
				
			||||||
        raise  # OKAY
 | 
					        raise  # OKAY
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Text encoding
 | 
					 | 
				
			||||||
-------------
 | 
					 | 
				
			||||||
- 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.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
- All external text that is not explicitly encoded (database storage,
 | 
					 | 
				
			||||||
  commandline arguments, etc.) should be presumed to be encoded as utf-8.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
    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
 | 
					Release Notes
 | 
				
			||||||
-------------
 | 
					-------------
 | 
				
			||||||
- Each patch should add an entry in the doc/source/index.rst file under
 | 
					- Any patch that makes a change significant to the end consumer or deployer of an
 | 
				
			||||||
  "MASTER".
 | 
					  OpenStack environment should include a release note (new features, upgrade impacts,
 | 
				
			||||||
 | 
					  deprecated functionality, significant bug fixes, etc.)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
- On each new release, the entries under "MASTER" will become the release notes
 | 
					- Cinder Client uses Reno for release notes management. See the `Reno Documentation`_
 | 
				
			||||||
  for that release, and "MASTER" will be cleared.
 | 
					  for more details on its usage.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
- The format should match existing release notes.  For example, a feature::
 | 
					.. _Reno Documentation: http://docs.openstack.org/developer/reno/
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    * Add support for function foo
 | 
					- 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:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
  Or a bug fix::
 | 
					    $ tox -e venv -- reno new add-awesome-command
 | 
				
			||||||
 | 
					    $ vi releasenotes/notes/add-awesome-command-bb8bb8bb8bb8bb81.yaml
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    .. _1241941: http://bugs.launchpad.net/python-cinderclient/+bug/1241941
 | 
					  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.
 | 
				
			||||||
 
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user