@@ -9,6 +9,12 @@ focus on the intent of the code and work together with a minimum of friction.
9
9
---
10
10
body:
11
11
12
+ ## Need of Guidelines
13
+
14
+ These Python Guidelines provides context to the developers who are new to the
15
+ codebase and wishes to make any real-world contribution with
16
+ ` org:creativecommons ` and be a part of the organization and learn new things
17
+ with the organization.
12
18
13
19
## Code Formatting
14
20
@@ -67,9 +73,11 @@ warning for [Whitespace before ':' (E203)][e203].
67
73
68
74
### Overview
69
75
70
- All the imports in the Python code must be done via [ isort] [ isort ] , a Python utility/library
71
- to sort imports alphabetically, and automatically separated into sections and by type.
72
- It provides a command line utility, Python library and [ plugins for various editors] ( https://github.com/pycqa/isort/wiki/isort-Plugins )
76
+ All the imports in the Python code must be done via [ isort] [ isort ] , a Python
77
+ utility/library to sort imports alphabetically, and automatically separated
78
+ into sections and by type.
79
+ It provides a command line utility, Python library and
80
+ [ plugins for various editors] ( https://github.com/pycqa/isort/wiki/isort-Plugins )
73
81
to quickly sort all your imports. It requires Python 3.6+ to run but
74
82
supports formatting Python 2 code too.
75
83
@@ -79,16 +87,13 @@ supports formatting Python 2 code too.
79
87
### Configuration
80
88
81
89
There's a good ` isort ` config which one should follow while contributing
82
- in the Python projects of the creativecommons. These configurations should be a part of
83
- ` pyproject.toml ` labelled as ` [tools.isort] `
90
+ in the Python projects of the creativecommons. These configurations should
91
+ be a part of ` pyproject.toml ` labelled as ` [tools.isort] `
84
92
85
93
- Isort Configuration (` pyproject.toml ` ): [ GitHub Search · org: creativecommons
86
- filename: pyproject .toml] [ isortconfig ]
87
- - GitHub Actions workflow: [ GitHub Search · org: creativecommons "pipenv run
88
- isort"] [ isortactions ]
94
+ filename: pyproject .toml] [ isortconfig ]
89
95
90
96
[ isortconfig ] : https://github.com/search?q=org%3Acreativecommons+filename:pyproject.toml
91
- [ isortactions ] : https://github.com/search?q=org%3Acreativecommons+%22pipenv+run+isort%22&type=code
92
97
93
98
94
99
## Development Environment
0 commit comments