You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+11-8Lines changed: 11 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -54,14 +54,15 @@ An Algorithm is one or more functions (or classes) that:
54
54
Algorithms should be packaged in a way that would make it easy for readers to integrate them into larger programs.
55
55
56
56
Algorithms should:
57
-
* have intuitive class and function names that make their purpose clear to readers,
58
-
* use Python naming conventions and intuitive variable names to ease comprehension,
59
-
* be flexible to take different input values,
60
-
* have Python type hints for their input parameters and return values,
61
-
* raise Python exceptions (`ValueError`, etc.) on erroneous input values,
62
-
* have docstrings with clear explanations and/or URLs to source materials,
63
-
* contain doctests that test both valid and erroneous input values,
64
-
* return all calculation results instead of printing or plotting them.
57
+
58
+
- have intuitive class and function names that make their purpose clear to readers,
59
+
- use Python naming conventions and intuitive variable names to ease comprehension,
60
+
- be flexible to take different input values,
61
+
- have Python type hints for their input parameters and return values,
62
+
- raise Python exceptions (`ValueError`, etc.) on erroneous input values,
63
+
- have docstrings with clear explanations and/or URLs to source materials,
64
+
- contain doctests that test both valid and erroneous input values,
65
+
- return all calculation results instead of printing or plotting them.
65
66
66
67
Algorithms in this repo should not be simple how-to examples for existing Python packages. Instead, they should perform internal calculations or manipulations to convert input values into different output values. These calculations or manipulations can use data types, classes, or functions of existing Python packages, but each algorithm in this repo should add unique value.
67
68
@@ -93,6 +94,7 @@ That's it! The plugin will run every time you commit any changes. If any errors
93
94
```bash
94
95
pre-commit run --all-files --show-diff-on-failure
95
96
```
97
+
96
98
#### Coding Style
97
99
98
100
We want your work to be readable by others; therefore, we encourage you to note the following:
@@ -119,6 +121,7 @@ We want your work to be readable by others; therefore, we encourage you to note
119
121
python3 -m pip install ruff # only required the first time
120
122
ruff check
121
123
```
124
+
122
125
- Original code submission require docstrings or comments to describe your work.
123
126
124
127
- Original code submissions require docstrings or comments to describe your work.
0 commit comments