nova-powervm/HACKING.rst
Drew Thorstensen 095e1c183b Initial Load of Nova PowerVM Project
Initial work to enable the Nova PowerVM project in git.

The work done here provides:
 - .gitignore - Indicate which files not to track within Git.
 - .gitreview - Input to the git-review command on how to send to
                Gerrit.
 - .testr.conf - Conf file input for the testr command (UT)
 - CONTRIBUTING.rst - Information on how to contribute.
 - HACKING.rst - Information on what needs to be done for updates.
 - LICENSE - The license for the project
 - README.rst - Information on what this project is.  Currently this is
                the blueprint.
 - openstack-common.conf - Required openstack configuration for all
                           projects
 - setup.cfg - Input to the setup.py on how to execute certain actions.
 - setup.py - Used for build of the project.
 - requirements.txt - Required packages (and levels) to run the code.
 - test-requirements.txt - Required packages (and levels) in addition
                           to the requirements, that indicates what is
                           needed to run the UT.
 - tox.ini - The input for the tox commands.

In addition, a base set of packages for the agent and unit tests were
loaded in.

Change-Id: Iaa186e449e7e0f75dc06a033d024a23d7faa0267
2014-10-21 15:03:58 -05:00

22 lines
807 B
ReStructuredText

Nova-PowerVM Style Commandments
===============================
- Step 1: Read the OpenStack Style Commandments
http://docs.openstack.org/developer/hacking/
- Step 2: Read on
Nova-PowerVM Specific Commandments
----------------------------------
- Follow the Nova HACKING.rst
Creating Unit Tests
-------------------
For every new feature, unit tests should be created that both test and
(implicitly) document the usage of said feature. If submitting a patch for a
bug that had no unit test, a new passing unit test should be added. If a
submitted bug fix does have a unit test, be sure to add a new one that fails
without the patch and passes with the patch.
For more information on creating unit tests and utilizing the testing
infrastructure in OpenStack Nova, please read ``nova/tests/README.rst``.