Skip to content

Commit

Permalink
corrected link to writingGoodReadmes.md
Browse files Browse the repository at this point in the history
  • Loading branch information
theile committed Nov 12, 2019
1 parent 1f41172 commit bb7992f
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion HowToCodeReview.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ If you (the author of code) want your code to be reviewed, please try to make li
* you may want to review the code by yourself first. Ask yourself the question: will someone else be able to understand what you want to do in every line of code?
* programming languages can be written in a specific *style*. Use a good *style guide* for your language ([Python](https://www.python.org/dev/peps/pep-0008/), [R](http://adv-r.had.co.nz/Style.html), (google for *"programming language" style guide*)) and adhere to it.
* make sure your code does not depend on very specific requirements that are only met on your PC.
* write a readme-file. Read [this guide](readme.md) on what should be included in a readme-file.
* write a readme-file. Read [this guide](writingGoodReadmes.md) on what should be included in a readme-file.
* use [Git](https://git-scm.com). This allows us to do incremental code reviews. It also shows you what the reviewer changed.
* use Git and [Github](https://github.molgen.mpg.de/) for bigger projects to allow incremental code reviews with the tools of Github.

Expand Down

0 comments on commit bb7992f

Please sign in to comment.