Giter Club home page Giter Club logo

code-review-checklist-plugin's Introduction

Code Review Checklist Plugin

The most effective and efficient way to do a code review is to have a checklist listing common gotchas. This chrome plugin is a tool for managing those checklists.

Installing The Extension

  1. Clone this repo
  2. Visit chrome://extensions in your browser
  3. Ensure "Developer mode" checkbox is checked
  4. Click "Load unpacked extension..."
  5. Select the directory where you cloned the repo

How It Works

When you click on the extension's icon, the code will see if you have an existing checklist for that URL. If you don't, it will create a new one based on a master template.

Each time you check a box on the checklist for the given URL, the checklist will get saved.

Purging

The extension will purge old checklists as needed.

Todos

  • prettification
    • make it more obvious that subheadings are collapsible
    • better stylings
  • allow user to change master template

Things To Note

The default template rarely contains things you can use a linter to find. Not only are the settings for that different for every developer or organization, you can (and should) use computers to do this checking.

Bibliography

  • Release It!: Michael Nygard
  • Code Complete: McConnell
  • Practical Code Inspection Techniques for Object-Oriented Systems: An Experimental Comparison: Dunsmore, Roper, Wood
  • Debugging effort estimation using software metrics: Gorla, Benander, and Benander
  • The Last Line Effect: Beller, Zaidman, and Karpov
  • Feature Toggles: Practitioner Practices and a Case Study: Rahman, Quere, Rigby, and Adams

code-review-checklist-plugin's People

Contributors

derricks avatar jeffkole avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.