File: HACKING.rst

package info (click to toggle)
python-saharaclient 2.0.0-2.1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 1,024 kB
  • sloc: python: 9,604; makefile: 31; sh: 8
file content (45 lines) | stat: -rw-r--r-- 1,295 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
Sahara Style Commandments
=========================

- Step 1: Read the OpenStack Style Commandments
  https://docs.openstack.org/hacking/latest/
- Step 2: Read on

Sahara Specific Commandments
----------------------------

Commit Messages
---------------
Using a common format for commit messages will help keep our git history
readable. Follow these guidelines:

- [S365] First, provide a brief summary of 50 characters or less. Summaries
  of greater than 72 characters will be rejected by the gate.

- [S364] The first line of the commit message should provide an accurate
  description of the change, not just a reference to a bug or blueprint.

Imports
-------
- [S366, S367] Organize your imports according to the ``Import order``

Dictionaries/Lists
------------------

- [S360] Ensure default arguments are not mutable.
- [S368] Must use a dict comprehension instead of a dict constructor with a
         sequence of key-value pairs. For more information, please refer to
         http://legacy.python.org/dev/peps/pep-0274/

Logs
----

- [S373] Don't translate logs

- [S374] You used a deprecated log level

Importing json
--------------

- [S375] It's more preferable to use ``jsonutils`` from ``oslo_serialization``
         instead of ``json`` for operating with ``json`` objects.