| 1 |
* Other style/readability fixes |
| 2 |
|
| 3 |
Signed-off-by: Aaron Bauman <bman@g.o> |
| 4 |
--- |
| 5 |
DEVELOPING | 18 +++++++++++------- |
| 6 |
1 file changed, 11 insertions(+), 7 deletions(-) |
| 7 |
|
| 8 |
diff --git a/DEVELOPING b/DEVELOPING |
| 9 |
index 31b559402..7bc559125 100644 |
| 10 |
--- a/DEVELOPING |
| 11 |
+++ b/DEVELOPING |
| 12 |
@@ -1,17 +1,15 @@ |
| 13 |
Code Guidelines |
| 14 |
--------------- |
| 15 |
+ |
| 16 |
A few code guidelines to try to stick to, please comment if none of |
| 17 |
these make sense, they are pretty basic and mostly apply to old code. |
| 18 |
-However for people who are looking at current code, they make take up |
| 19 |
+However for people who are looking at current code, they may take up |
| 20 |
bad habits that exist in the current codebase. |
| 21 |
|
| 22 |
Python Version |
| 23 |
-------------- |
| 24 |
|
| 25 |
-Python 2.7 is the minimum supported version as it eases 3.x compatibility. |
| 26 |
-All exception handling should use Python 3 'except' syntax, and the print |
| 27 |
-function should be used instead of Python 2's print statement (use "from |
| 28 |
-__future__ import print_function" everywhere). |
| 29 |
+Python 3.6 is the minimum supported version. |
| 30 |
|
| 31 |
Dependencies |
| 32 |
------------ |
| 33 |
@@ -30,7 +28,7 @@ width. |
| 34 |
Line-Wrapping |
| 35 |
------------- |
| 36 |
|
| 37 |
-Lines should typically not be longer than 80 characters; if they are an |
| 38 |
+Lines should typically not be longer than 80 characters; if they are, an |
| 39 |
attempt should be made to wrap them. Move code to the line below and |
| 40 |
indent once (\t). |
| 41 |
|
| 42 |
@@ -47,7 +45,7 @@ errors.append(MalformedMetadata( |
| 43 |
attr='DESCRIPTION.toolong') |
| 44 |
|
| 45 |
The mixing of tabs and spaces means other developers can't read what you |
| 46 |
-did. This is why the python peps state spaces over tabs; because with |
| 47 |
+did. This is why the Python PEPs state spaces over tabs; because with |
| 48 |
spaces the line wrapping is always clear (but you cannot convert spaces |
| 49 |
as easily as tabwidth). |
| 50 |
|
| 51 |
@@ -189,12 +187,18 @@ at 72. Prefix the message with the component you touched if this makes |
| 52 |
sense. Postfix the message with the bug it fixes, if it does. |
| 53 |
|
| 54 |
Feel free to use the following notes (if applicable): |
| 55 |
+ |
| 56 |
Signed-off-by: Wrote (a substantial portion of) the patch |
| 57 |
+ |
| 58 |
Reviewed-by: Reviewed the patch thoroughly |
| 59 |
+ |
| 60 |
Tested-by: Tested the patch thoroughly |
| 61 |
+ |
| 62 |
Acked-by: Approved the concept but did not read the patch in detail |
| 63 |
(typically used by the maintainer of a specific portion, or a lead) |
| 64 |
+ |
| 65 |
Suggested-by: Designed the implementation |
| 66 |
+ |
| 67 |
Requested-by: Reported the bug/made the feature request |
| 68 |
|
| 69 |
Example: |
| 70 |
-- |
| 71 |
2.28.0 |
Archives