aboutsummaryrefslogtreecommitdiffstats
path: root/keystonemiddleware-moon/HACKING.rst
diff options
context:
space:
mode:
Diffstat (limited to 'keystonemiddleware-moon/HACKING.rst')
-rw-r--r--keystonemiddleware-moon/HACKING.rst24
1 files changed, 24 insertions, 0 deletions
diff --git a/keystonemiddleware-moon/HACKING.rst b/keystonemiddleware-moon/HACKING.rst
new file mode 100644
index 00000000..77de6b32
--- /dev/null
+++ b/keystonemiddleware-moon/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
+=======
+
+Keystone Middleware 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/