Created
May 9, 2017 18:59
-
-
Save aspencer8111/7f396d4f30aed949acc12464c2aae0e8 to your computer and use it in GitHub Desktop.
PR Checklist
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Pull-request Checklist | |
====================== | |
A checklist I shamelessly stole from @anhari. | |
Sweep | |
----- | |
[ ] Any unnecessary comments? | |
[ ] Deleted all debugging statements? | |
Styling | |
------- | |
[ ] Are all rules alphabetical? | |
[ ] Any nesting more than two levels deep? | |
[ ] Are you using variables where possible? | |
[ ] Any mixins hiding in your styles? | |
Single Responsibility Principle | |
------------------------------- | |
[ ] Do your classes do the smallest possible useful thing? | |
[ ] For each class, rephrase every method as a question. Do the questions make | |
sense? (I.e. "Please Mr. Gear, what is your tire size?") | |
[ ] Can you describe each class in a single sentence? Did "and"/"or" appear in | |
that sentence? | |
[ ] Does another class exist? | |
[ ] Any methods iterating and performing actions? | |
[ ] Are you referencing any instance variables instead of using an attr_reader? | |
[ ] Are there any data structures you can hide? Do any objects have to infer the | |
structure of another object? | |
Dependencies | |
------------ | |
Interfaces | |
---------- | |
[ ] Any cases of "how" instead of "what"? | |
[ ] Are there any Demeter "trainwrecks"? | |
Finding hidden ducks | |
-------------------- | |
[ ] Any case statements that switch on a class? Use a duck. | |
[ ] Any uses of `kind_of?` or `is_a?`? Use a duck. | |
[ ] Any usage of `responds_to?`? Use a duck. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment