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