Peer Review Guidelines

Peer Review

Ombu Labs, February 2015

Git Branches

masterIt’s production!

developIt’s the unstable branch

feature/twitter-integrationIt describes a feature

hotfixes/price-bugIt describes a bug fix

Pull Requests

TitleBrief summary of what it is

DescriptionLonger description of the changes

CommitsMake them as granular as possible

CodeChanges to the code

Test CoverageChanges that prove your changes work

Guidelines

Be niceDon’t be mean, we are all learning

Don’t take it personalAny code can be improved

KISSSolve a concrete problem now

RefactorYou can always refactor later

Don’t design for the future

You’re not an oracle, neither am I

DocumentAny public interface should be documented (YARD)

Check GuidelinesWe should all follow our style guidelines

FunctionalityDoes it do what it says it does?

PerformanceIs the code really performant?

All Pull Requests Must Be

Peer Reviewed

THANK YOU!

questions?