Skip to content

Commit bb667a3

Browse files
[pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
1 parent 86b4625 commit bb667a3

1 file changed

Lines changed: 17 additions & 13 deletions

File tree

CONTRIBUTING.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -45,12 +45,12 @@ GitHub will use this tag to [auto-close the issue](https://docs.github.com/en/is
4545
#### What is an Algorithm?
4646

4747
An algorithm is one or more functions (or classes) that:
48-
* take one or more inputs,
49-
* perform some internal calculations or data manipulations,
50-
* return one or more outputs,
51-
* have minimal side effects (e.g., `print()`, `plot()`, `read()`, `write()`).
52-
An Algorithm is one or more functions (or classes) that:
5348

49+
- take one or more inputs,
50+
- perform some internal calculations or data manipulations,
51+
- return one or more outputs,
52+
- have minimal side effects (e.g., `print()`, `plot()`, `read()`, `write()`).
53+
An Algorithm is one or more functions (or classes) that:
5454
- take one or more inputs,
5555
- perform some internal calculations or data manipulations,
5656
- return one or more outputs,
@@ -59,14 +59,15 @@ An Algorithm is one or more functions (or classes) that:
5959
Algorithms should be packaged in a way that would make it easy for readers to integrate them into larger programs.
6060

6161
Algorithms should:
62-
* have intuitive class and function names that make their purpose clear to readers,
63-
* use Python naming conventions and intuitive variable names to ease comprehension,
64-
* be flexible to take different input values,
65-
* have Python type hints for their input parameters and return values,
66-
* raise Python exceptions (`ValueError`, etc.) on erroneous input values,
67-
* have docstrings with clear explanations and/or URLs to source materials,
68-
* contain doctests that test both valid and erroneous input values,
69-
* return all calculation results instead of printing or plotting them.
62+
63+
- have intuitive class and function names that make their purpose clear to readers,
64+
- use Python naming conventions and intuitive variable names to ease comprehension,
65+
- be flexible to take different input values,
66+
- have Python type hints for their input parameters and return values,
67+
- raise Python exceptions (`ValueError`, etc.) on erroneous input values,
68+
- have docstrings with clear explanations and/or URLs to source materials,
69+
- contain doctests that test both valid and erroneous input values,
70+
- return all calculation results instead of printing or plotting them.
7071

7172
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.
7273

@@ -92,13 +93,15 @@ Use [pre-commit](https://pre-commit.com/#installation) to automatically format y
9293
python3 -m pip install pre-commit # only required the first time
9394
pre-commit install
9495
```
96+
9597
That's it! The plugin will run every time you commit any changes. If there are any errors found during the run, fix them and commit those changes. You can even run the plugin manually on all files:
9698

9799
That's it! The plugin will run every time you commit any changes. If any errors are found during the run, fix them and commit those changes. You can even run the plugin manually on all files:
98100

99101
```bash
100102
pre-commit run --all-files --show-diff-on-failure
101103
```
104+
102105
#### Coding Style
103106

104107
We want your work to be readable by others; therefore, we encourage you to note the following:
@@ -125,6 +128,7 @@ We want your work to be readable by others; therefore, we encourage you to note
125128
python3 -m pip install ruff # only required the first time
126129
ruff check
127130
```
131+
128132
- Original code submission require docstrings or comments to describe your work.
129133

130134
- Original code submissions require docstrings or comments to describe your work.

0 commit comments

Comments
 (0)