Skip to content

Commit db4f98d

Browse files
committed
added context for need of guidelines
1 parent 1faa46e commit db4f98d

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

content/contributing-code/python-guidelines/contents.lr

+14-9
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@ focus on the intent of the code and work together with a minimum of friction.
99
---
1010
body:
1111

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.
1218

1319
## Code Formatting
1420

@@ -67,9 +73,11 @@ warning for [Whitespace before ':' (E203)][e203].
6773

6874
### Overview
6975

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)
7381
to quickly sort all your imports. It requires Python 3.6+ to run but
7482
supports formatting Python 2 code too.
7583

@@ -79,16 +87,13 @@ supports formatting Python 2 code too.
7987
### Configuration
8088

8189
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]`
8492

8593
- 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]
8995

9096
[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
9297

9398

9499
## Development Environment

0 commit comments

Comments
 (0)