Skip to content
This repository has been archived by the owner on Jul 22, 2018. It is now read-only.

Latest commit

 

History

History
58 lines (47 loc) · 2.89 KB

Semi-Automatic-Code-Review.md

File metadata and controls

58 lines (47 loc) · 2.89 KB
Raw

Presenter: Richard Huang

Bio

Richard Huang is a senior engineer, a passionate rubyist and open source advocate, he created rails_best_practices gem, and also built the websites rails-bestpractices.com and railsbp.com

Abstract

Rails is so popular to be used to fast build a website, at the beginning we sometimes write codes too fast without considering code quality, but after your company grows fast, you have to pay more attentions on code review to make your website more robust and more maintainable.

In this talk I will introduce you a way to build a semi automatic code review process, in this process a tool will analyze the source codes of your rails project, then give you some suggestions to refactor your codes according to rails best practices. It can also check your codes according to your team's rails code guideline. So engineers can focus on implementation performance, scalability, etc. when they do code review.

Summary

Automation of tasks is important. This talk discussed the speaker's open-source rails_best_practices gem (similar to JSLint in concept) and its associated web service. It can point out code smells, etc. as a GitHub hook. If you already use GitHub and do pull requests for code review, this can automate simple detection.

Notes

From @benjaminoakes

  • He works on OpenFeint
  • Prefer automatic processes to manual processes (e.g., automatic testing)
  • Totally manual: code review
    • Automatic tests / manual verification
    • Automated deploy via Capistrano
    • But can you automate code review?
  • What is review?
    • Easy
      • Coding guidelines
      • Syntax
      • Remove unused methods
    • Difficult
      • Performant
      • Scalable
    • Automate "easy"
    • Gem: rails_best_practices
      • Can suggest things like "use scope access", "use model association", or "use query attribute")
    • A code review service?
      • railsbp.com
      • Integrates with GitHub (service hook); looks similar to Travis CI if you've used that
      • Tracks history
      • Configurble
      • Gives analysis in web UI
      • Configuration
      • Cost: unclear (TODO check site; looks like donations)
      • Plugins are possible (e.g., for try())
      • Both the site and gem are OSSS

External Links