erran-r7 / chef-style-guide

A Chef Style Guide for cookbooks, recipes, and Ruby code

Chef Style Guides

Prelude

This repository is a group of style guides I follow when writing Chef components. As more people begin to contribute to the Rapid7 Cookbooks GitHub organization: @rapid7-cookbooks I'd love for a consistent style to be used across the repositories/cookbooks released. -- Erran Carey, a.k.a @ipwnstuff/@ecarey-r7

Contributors to repositories @rapid7-cookbooks are asked to adhere to the style guides listed in below. Feedback is welcome and pull requests are welcome to add a thread for discussion if you have a different preference or one you'd like to add.

Style Guides:

Note: Make sure to check out @bbatsov's Ruby Style Guide for Ruby style.

• Chef specific style guides:
  • Best practices style guide
  • Cookbooks tyle guide
  • Recipes style guide
  • Ruby style in Chef