summaryrefslogtreecommitdiff
path: root/HACKING.rst
diff options
context:
space:
mode:
authorMorgan Fainberg <morgan.fainberg@gmail.com>2014-06-19 15:45:29 -0700
committerMorgan Fainberg <morgan.fainberg@gmail.com>2014-06-19 15:45:29 -0700
commit0fa3fe55760c7366ebfe57a7e352c816e0ce54c8 (patch)
tree5356f3effd3e36f94842130d196269ee3b2ca5c2 /HACKING.rst
downloadkeystonemiddleware-0fa3fe55760c7366ebfe57a7e352c816e0ce54c8.tar.gz
Initial commit
The initial commit of the keystonemiddleware repo
Diffstat (limited to 'HACKING.rst')
-rw-r--r--HACKING.rst24
1 files changed, 24 insertions, 0 deletions
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/