aboutsummaryrefslogtreecommitdiffstats
path: root/keystone-moon/HACKING.rst
diff options
context:
space:
mode:
authorRHE <rebirthmonkey@gmail.com>2017-11-24 13:54:26 +0100
committerRHE <rebirthmonkey@gmail.com>2017-11-24 13:54:26 +0100
commit920a49cfa055733d575282973e23558c33087a4a (patch)
treed371dab34efa5028600dad2e7ca58063626e7ba4 /keystone-moon/HACKING.rst
parentef3eefca70d8abb4a00dafb9419ad32738e934b2 (diff)
remove keystone-moon
Change-Id: I80d7c9b669f19d5f6607e162de8e0e55c2f80fdd Signed-off-by: RHE <rebirthmonkey@gmail.com>
Diffstat (limited to 'keystone-moon/HACKING.rst')
-rw-r--r--keystone-moon/HACKING.rst58
1 files changed, 0 insertions, 58 deletions
diff --git a/keystone-moon/HACKING.rst b/keystone-moon/HACKING.rst
deleted file mode 100644
index 86bce201..00000000
--- a/keystone-moon/HACKING.rst
+++ /dev/null
@@ -1,58 +0,0 @@
-Keystone Style Commandments
-===========================
-
-- Step 1: Read the OpenStack Style Commandments
- http://docs.openstack.org/developer/hacking/
-- Step 2: Read on
-
-Keystone Specific Commandments
-------------------------------
-
-- Avoid using "double quotes" where you can reasonably use 'single quotes'
-
-
-TODO vs FIXME
--------------
-
-- TODO(name): implies that something should be done (cleanup, refactoring,
- etc), but is expected to be functional.
-- FIXME(name): implies that the method/function/etc shouldn't be used until
- that code is resolved and bug fixed.
-
-
-Logging
--------
-
-Use the common logging module, and ensure you ``getLogger``::
-
- from oslo_log import log
-
- LOG = log.getLogger(__name__)
-
- LOG.debug('Foobar')
-
-
-AssertEqual argument order
---------------------------
-
-assertEqual method's arguments should be in ('expected', 'actual') order.
-
-
-Properly Calling Callables
---------------------------
-
-Methods, functions and classes can specify optional parameters (with default
-values) using Python's keyword arg syntax. When providing a value to such a
-callable we prefer that the call also uses keyword arg syntax. For example::
-
- def f(required, optional=None):
- pass
-
- # GOOD
- f(0, optional=True)
-
- # BAD
- f(0, True)
-
-This gives us the flexibility to re-order arguments and more importantly
-to add new required arguments. It's also more explicit and easier to read.