fullstackla / pairing-meetup

⚡ 📻 Open Source Pair Programming every month in downtown & Santa Monica
http://www.meetup.com/la-fullstack/
MIT License
34 stars 19 forks source link

Exercism: Wiki of "code smells" for nitpicking #14

Closed machikoyasuda closed 8 years ago

kennethlee commented 8 years ago

I'll get started on this.

I'm going to try to keep it as light and approachable as possible so as to be beginner-friendly.

machikoyasuda commented 8 years ago

example: http://exercism.io/submissions/e3b4a0a869af4c25af828bdb12d631d2

Whenever you are looping through a collection and find yourself writing a conditional (if or unless) nested inside of the loop, take a moment to look through the available enumerable methods.

There are some very handy ones that might let you simplify.

machikoyasuda commented 8 years ago

Here are all of Rikki's automated comments: https://github.com/exercism/rikki/tree/master/comments/analyzer/ruby

machikoyasuda commented 8 years ago

-- Naming: http://www.sitepoint.com/whats-in-a-name-anti-patterns-to-a-hard-problem/ -- Naming: http://blog.thecodewhisperer.com/permalink/a-model-for-improving-names

machikoyasuda commented 8 years ago

-- Style: https://github.com/thoughtbot/guides

machikoyasuda commented 8 years ago

@kennethlee sorry to switch things up but can you make this as a file in the repo instead? https://github.com/fullstackla/pairing-meetup/wiki/Code-Smells

machikoyasuda commented 8 years ago

@kennethlee this is a nice list to incorporate too: http://lasoftwarecraftsmanship.com/clean-code-checklist/

maybe we can have 2 lists:

  1. code smells to check for
  2. clean code checklist

they are kind of inverses of each other. heh

kennethlee commented 8 years ago

@machikoyasuda That clean code checklist is helpful. It's also worded plainly enough so as to be pretty easy for newbies to grasp/understand so instead of reinventing the wheel by paraphrasing it, I emailed the author asking if we could add it to our repo as-is. I'll come back with his reply.

kennethlee commented 8 years ago

@machikoyasuda Michael Rice (the organizer for LA Software Craftsmanship meetup) got back to me over the weekend and graciously gave us permission to use their Clean Code Checklist. See PR #23