summaryrefslogtreecommitdiff
path: root/HACKING.rst
diff options
context:
space:
mode:
authorJoe Gordon <joe.gordon0@gmail.com>2013-11-11 11:04:05 -0800
committerJoe Gordon <joe.gordon0@gmail.com>2013-11-11 11:05:00 -0800
commit28243bedada8775de2aec496a69b2d4a278315d1 (patch)
treebce01bd0bcd03db37245efe2bb8f4465dc0f6e9e /HACKING.rst
parentdca1d4259d44a0d282396a18c895de834580fe66 (diff)
downloadpython-keystoneclient-28243bedada8775de2aec496a69b2d4a278315d1.tar.gz
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
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/