Add peer review notebook

Author: mandli

peer_review.ipynb

@@ -0,0 +1,124 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Peer Review Guidelines\n",
+    "\n",
+    "When writing a peer review give the code a look over and think about the questions below.  Giving a couple of sentences for each of the questions is sufficient.  Code examples are even better!\n",
+    "\n",
+    "1. Easy to read and understand?\n",
+    "   - Are the `doc-strings` useful?\n",
+    "   - Are variables and functions named descriptively when useful?\n",
+    "   - Are the comments helpful?\n",
+    "1. Does the code follow a consistent style?\n",
+    "   - Is there a consistent style? [PEP8](https://www.python.org/dev/peps/pep-0008/)\n",
+    "1. Is the code written succinctly and efficiently?\n",
+    "   - Was there superfluous code sections?\n",
+    "   - Was the code written clearly?\n",
+    "   - Was the code written elegantly without decreasing readability?\n",
+    "   \n",
+    "Make sure to suggest **constructive** ways to improve all of the above along with:\n",
+    " - Clever ways to use built-in functionality (when appropriate)\n",
+    " - Simpler ways to implement the same functionality\n",
+    " - General improvements to structure, style, and naming\n",
+    " - Be courteous to the person you are reviewing!\n",
+    "\n",
+    "\n",
+    "## Rubric\n",
+    "<table>\n",
+    "  <tr>\n",
+    "    <th>Criteria</th>\n",
+    "    <th>3 points</th>\n",
+    "    <th>2 points</th>\n",
+    "    <th>1 point</th>\n",
+    "  </tr>\n",
+    "  <tr>\n",
+    "    <td>Readability</td>\n",
+    "    <td><ul>\n",
+    "        <li>Doc-strings are clear and accurate</li>\n",
+    "        <li>Variables and functions are named descriptively when useful</li>\n",
+    "        <li>Comments are placed in appropriate places and are clear and accurate</li>\n",
+    "        </ul>\n",
+    "    </td>\n",
+    "    <td><ul>\n",
+    "        <li>Doc-strings are present but not completely descriptive</li>\n",
+    "        <li>Variables and functions are sometimes named helpfully</li>\n",
+    "        <li>Comments are present but not always accurate or in the most helpful of places</li>\n",
+    "        </ul>\n",
+    "    </td>\n",
+    "\n",
+    "    <td><ul>\n",
+    "        <li>No doc-strings</li>\n",
+    "        <li>Variables and functions are named indecipherably</li>\n",
+    "        <li>No or inaccurate comments</li>\n",
+    "        </ul>\n",
+    "    </td>\n",
+    "  </tr>\n",
+    "  <tr>\n",
+    "    <td>Style</td>\n",
+    "    <td><ul>\n",
+    "        <li><a href=\"https://www.python.org/dev/peps/pep-0008/\">PEP 8</a> or other style is consistent</li>\n",
+    "        <li>Indentation is clean and not mixed</li>\n",
+    "       </ul>\n",
+    "    <td><ul>\n",
+    "        <li>Style is mostly consistent with something</li>\n",
+    "       </ul>\n",
+    "    </td>\n",
+    "    <td><ul>\n",
+    "        <li>Style is of a by-gone era but may come back someday (not today)</li>\n",
+    "       </ul>\n",
+    "    </td>\n",
+    "  </tr>\n",
+    "  <tr>\n",
+    "    <td>Code Awesome</td>\n",
+    "    <td><ul>\n",
+    "        <li>Code was succinct and clean</li>\n",
+    "        <li>Upon a glance you completely understood the code</li>\n",
+    "        <li>This code defines elegance</li>\n",
+    "    </td>\n",
+    "    <td><ul>\n",
+    "        <li>Code was overall clean but there were a couple spots</li>\n",
+    "        <li>Code was mostly clear except for a couple of spots</li>\n",
+    "        <li>Code worked but may have been a bit hard to follow</li>\n",
+    "    </td>\n",
+    "    <td><ul>\n",
+    "        <li>Code had large sections that did nothing</li>\n",
+    "        <li>Code was very hard to follow</li>\n",
+    "        <li>Code got the job done but no one would ever understand why</li>\n",
+    "    </ul></td>\n",
+    "  </tr>\n",
+    "</table>\n"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 2",
+   "language": "python",
+   "name": "python2"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.6.2"
+  },
+  "latex_envs": {
+   "bibliofile": "biblio.bib",
+   "cite_by": "apalike",
+   "current_citInitial": 1,
+   "eqLabelWithNumbers": true,
+   "eqNumInitial": 0
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 1
+}