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
{{ message }}
Repository navigation
Commit 7233a2a
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+1-15Lines changed: 1 addition & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,7 +53,7 @@ An algorithm is one or more functions (or classes) that:
53
53
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
-
Algorithms should:
56
+
#### Algorithms should:
57
57
58
58
- have intuitive class and function names that make their purpose clear to readers,
59
59
- use Python naming conventions and intuitive variable names to ease comprehension,
@@ -67,20 +67,6 @@ Algorithms should:
67
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.
68
68
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.
69
69
70
-
#### Pre-Commit Plugin
71
-
72
-
- have intuitive class and function names that make their purpose clear to readers
73
-
- use Python naming conventions and intuitive variable names to ease comprehension
74
-
- be flexible to take different input values
75
-
- have Python type hints for their input parameters and return values
76
-
- raise Python exceptions (`ValueError`, etc.) on erroneous input values
77
-
- have docstrings with clear explanations and/or URLs to source materials
78
-
- contain doctests that test both valid and erroneous input values
79
-
- return all calculation results instead of printing or plotting them
80
-
81
-
Algorithms in this repo should not be how-to examples for existing Python packages. Instead, they should perform internal calculations or manipulations to convert input values into different output values.
82
-
Those calculations or manipulations can use data types, classes, or functions of existing Python packages, but each algorithm in this repo should add unique value.
83
-
84
70
#### Pre-commit
85
71
86
72
Use [pre-commit](https://pre-commit.com/#installation) to automatically format your code to match our coding style:
0 commit comments