Foodcritic Bug Bash!


#1

Ohai Chefs,

I’d like to enlist your help. Many of the Opscode community cookbooks
produce warnings when run through foodcritic. As part of the ongoing
work to improve the overall quality of the Opscode community
cookbooks, I and others would like to fix these failures.

If you have been looking for a way to contribute to community
cookbooks, see the “Scope” and “How to Help” sections below for how
you can help eradicate foodcritic failures.

How to Help

If you want to help fix these foodcritic failures, here is how to
proceed:

  1. Make sure that you have a CLA signed:

    http://wiki.opscode.com/display/chef/How+to+Contribute

  2. Using the following JIRA filter, find an unassigned cookbook you
    are interested in fixing:

http://tickets.opscode.com/secure/IssueNavigator.jspa?mode=hide&requestId=11799

  1. Assign the bug for that cookbook to yourself.

  2. Fix any foodcritic failures you find (ignoring those on the list below).

  3. If the cookbook has test-kitchen support, ensure test-kitchen still
    passes.

  4. Push your fixes to a publicly accessible git branch.

  5. If your git branch is on Github, optionally open a pull request.

  6. Mark the bug as “Fix Provided” and comment with a link to the
    branch.

I will be helping to review and merge these fixes as they come in
rather than waiting for the normal code review meetings.

Scope

To make this first pass manageable, we are not looking at all
foodcritic failures. Specifically we will be ignoring the following:

  • FC003
  • FC004
  • FC007
  • FC015
  • FC017
  • FC023
  • FC035

If you are interested in why these rules are being ignored for now, I’ve
written up a short reason for each exception here:

Please follow up over email or in #chef-hacking on Freenode with any
questions.

Cheers,

Steven

Steven Danna
Systems Engineer, Opscode, Inc
GPG Key: http://stevendanna.github.com/downloads/code/public.key