docs/concepts.rst @ cf64f6f74ad3 initial-docs

docs: more doc work
author Steve Losh <steve@stevelosh.com>
date Mon, 14 Jun 2010 23:38:00 -0400
parents 480c971af727
children 9307f4023849
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
-----------------------

Repository Structure
--------------------