Skip to content

Commit b42151f

Browse files
authored
Add reviewer checklist to the guides
1 parent a860e63 commit b42151f

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

Reviewer_Checklist.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Reviewer Checklist
2+
3+
* Include references to the used algorithms in the docstring
4+
* If the algorithm is new, please include a description in the docstring, or be sure to include a reference as soon as you publish the work
5+
* The code should be easily readable (for infos e.g. here [here](https://treyhunner.com/2017/07/craft-your-python-like-poetry/?__s=jf8h91lx6zhl7vv6o9jo))
6+
* Variable names should be chosen to be clear. Avoid `item, element, var, list` etc...
7+
* Avoid as much as possible hard-coded indices for list (no `x = l[0], y = l[1]`) (see also [here](https://treyhunner.com/2018/03/tuple-unpacking-improves-python-code-readability/))
8+
* Use pythonic loops, list comprehensions etc.
9+
* Make sure the unit test are testing all the relevant parts of the code
10+
* Check the docstring (is everything clearly explained, are the default values given an clear)

0 commit comments

Comments
 (0)