Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.

Peer Review Guidelines

558 views

Published on

A few guidelines for peer reviews at Ombu Labs. Be nice, be constructive, suggest alternatives, start discussions, use Git branches, Github pull requests and keep it lean.

Make sure that the pull requests solve a concrete problem today. You can always refactor your solution later. Do not design for the future.

Keep it simple stupid and learn from the comments in your pull requests.

Published in: Technology
  • Be the first to comment

  • Be the first to like this

Peer Review Guidelines

  1. 1. Peer Review Ombu Labs, February 2015
  2. 2. Git Branches
  3. 3. master It’s production!
  4. 4. develop It’s the unstable branch
  5. 5. feature/twitter-integration It describes a feature
  6. 6. hotfixes/price-bug It describes a bug fix
  7. 7. Pull Requests
  8. 8. Title Brief summary of what it is
  9. 9. Description Longer description of the changes
  10. 10. Commits Make them as granular as possible
  11. 11. Code Changes to the code
  12. 12. Test Coverage Changes that prove your changes work
  13. 13. Guidelines
  14. 14. Be nice Don’t be mean, we are all learning
  15. 15. Don’t take it personal Any code can be improved
  16. 16. KISS Solve a concrete problem now
  17. 17. Refactor You can always refactor later
  18. 18. Don’t design for the future You’re not an oracle, neither am I
  19. 19. Document Any public interface should be documented (YARD)
  20. 20. Check Guidelines We should all follow our style guidelines
  21. 21. Functionality Does it do what it says it does?
  22. 22. Performance Is the code really performant?
  23. 23. All Pull Requests Must Be Peer Reviewed
  24. 24. THANK YOU! questions?

×