cf64f6f74ad3 initial-docs

docs: more doc work
[view raw] [browse files]
author Steve Losh <steve@stevelosh.com>
date Mon, 14 Jun 2010 23:38:00 -0400
parents 289163ebca26
children 9307f4023849
branches/tags initial-docs
files docs/concepts.rst docs/hacking.rst docs/publish.sh

Changes

--- a/docs/concepts.rst	Mon Jun 14 23:22:33 2010 -0400
+++ b/docs/concepts.rst	Mon Jun 14 23:38:00 2010 -0400
@@ -1,9 +1,36 @@
 Concepts
 ========
 
+You're not perfect.
+
+Your code is not perfect.
+
+If you're the only person that's read your code, it's wrong. Period.
+
+As developers we need to review each other's code. This helps us catch errors
+before they find our users. It also makes us take greater care when writing
+code because we know someone will most definitely be looking at it.
+
 Code Review Basics
 ------------------
 
+The simplest form of code review is asking a friend to look at the code you
+just wrote. Often a second set of eyes can find problems you might not have
+seen, especially if that person has more experience than you.
+
+Unfortunately, this isn't always practical. You might work remotely with people
+thousands of miles away and not have a chance to simply turn around and say:
+"Hey, could you look at this?"
+
+Code review tools (like hg-review) exist to make reviewing other people's code
+easier.
+
+Their goal is to make it as easy as possible to tell another developer: "No,
+you did *this* wrong.  Fix it."
+
+Other Code Review Tools
+-----------------------
+
 Distributed Code Review
 -----------------------
 
--- a/docs/hacking.rst	Mon Jun 14 23:22:33 2010 -0400
+++ b/docs/hacking.rst	Mon Jun 14 23:38:00 2010 -0400
@@ -7,3 +7,5 @@
 Testing
 -------
 
+Documentation
+-------------
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/publish.sh	Mon Jun 14 23:38:00 2010 -0400
@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+make html
+rsync --delete -az _build/html/ ~/src/sjl.bitbucket.org/hg-review
+hg -R ~/src/sjl.bitbucket.org commit -Am 'hg-review: Update documentation.'
+hg -R ~/src/sjl.bitbucket.org push