From 28243bedada8775de2aec496a69b2d4a278315d1 Mon Sep 17 00:00:00 2001 From: Joe Gordon Date: Mon, 11 Nov 2013 11:04:05 -0800 Subject: Make HACKING.rst DRYer and turn into rst file Rename HACKING to HACKING.rst since it is a rst file and reference the OpenStack hacking guide and remove duplicated entries. Change-Id: I9994594c7f8cb0f011d949b273bea08c68985e16 --- HACKING.rst | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 HACKING.rst (limited to 'HACKING.rst') diff --git a/HACKING.rst b/HACKING.rst new file mode 100644 index 0000000..0dfef99 --- /dev/null +++ b/HACKING.rst @@ -0,0 +1,24 @@ +Keystone Style Commandments +=========================== + +- Step 1: Read the OpenStack Style Commandments + http://docs.openstack.org/developer/hacking/ +- Step 2: Read on + +Exceptions +---------- + +When dealing with exceptions from underlying libraries, translate those +exceptions to an instance or subclass of ClientException. + +======= +Testing +======= + +python-keystoneclient uses testtools and testr for its unittest suite +and its test runner. Basic workflow around our use of tox and testr can +be found at http://wiki.openstack.org/testr. If you'd like to learn more +in depth: + + https://testtools.readthedocs.org/ + https://testrepository.readthedocs.org/ -- cgit v1.2.1