Richie Khoo evolve2k

Code Comments

Don’t do it, a comment is a lie waiting to happen

If a comment is needed because the code is unclear, move it into it's own method with a nice name.
Write a unit test to explain things instead of using code comments.
Unit tests are executable, self verifying documentation.

It’s the universal ‘check here first’

We can use an implicit subject, meaning we don't need to specify the subject (and we revert back to #it):

subject { Customer.new(:name => "Frank Reynolds") }  

it { should be_valid }

We can also use an implicit subject based on the object we are describing:

	Steps to get postgres working on OSX (as I currently understand it)

	1. Install Postgres
	- A bunch of files are placed in uknown places?
	- A service starts running which is the database service
	- An initial conf file and conf database file are created?

	It's not working, steps to find out what exactly is not working.
	Eg which level the problem is at

	$ git reflog

	5ee192a HEAD@{0}: checkout: moving from master to 5ee192a62f39323c61a3b2527bbda1b6fbd669c8
	63322f5 HEAD@{1}: merge suite_spike_1: Fast-forward
	58c63d4 HEAD@{2}: checkout: moving from suite_spike_1 to master
	63322f5 HEAD@{3}: merge master: Merge made by the 'ours' strategy.
	713e4ae HEAD@{4}: commit: Update ProductSuite with website, discount text and omnium code
	ef7eb28 HEAD@{5}: checkout: moving from master to suite_spike_1
	58c63d4 HEAD@{6}: checkout: moving from suite_spike_1 to master
	(copy the head part for the commit I want to restore to)

	<date>

	<Previous Developers’s Name>
	<Previous Developers’s Position>
	<Company Name>

	Dear <Previous Developers Name>

	Ethical Clearance Letter
	Re: <Name of client>

	1. Utilise a good programmer task management tool
	I strongly recommend you utilise pivitol tracker.
	Have the developer keep the tasks they are working on up to date and ask them to communicate with you through pivitol tracker.

	2. Have the developer keep their source code in an online repository that you both have access to all the time.
	I strongly recommend that the code is kept at github.com in a private repository that you maintain.
	(It will costs you aprx $9 per month to do so).
	Have the developer tag each batch of code they work on with the specific task(story) they are working on at the time.

	3. Ensure your developer writes tests.

	<!DOCTYPE html>
	<html>
	<head>
	<title>Sideways Example</title>
	<link href='stylesheets/global.css' media='all' rel='stylesheet' />
	</head>
	<body>
	<h2 class="rotate">Look Ma Im sideways</h2>
	</body>
	</html>

	/* Arduino Blink - Lesson One */
	void setup()
	{

	pinMode (13, OUTPUT); //Set socket D12 as an output
	//pinMode (8, INPUT); //Set socket D8 as an input
	}

	void loop() {
	digitalWrite(13,HIGH);

	Metrics
	-------
	guag.es
	kiss metrics
	mixpanel
	http://chartbeat.com
	(eg. http://chartbeat.com/dashboard/?url=businessinsider.com&k=4bbb5a03ffbd1d760ecf0ba8d9f27ef7)

	AB Testing
	----------