openstack/openstack-chef
Code Issues Proposed changes

capturing some thoughts on making the repo more modular and accessible

Browse Source
This commit is contained in:
mattray
2012-07-26 15:59:09 -05:00
parent e45713253f
commit f095bcde10
1 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
documentation/style-guide.md Normal file
View File

@@ -0,0 +1,18 @@
Just to capture the proposed style of cookbooks and code in the repository.
Cookbooks
=========
Foodcritic
----------
Foodcritic (http://acrmp.github.com/foodcritic/) is extremely useful for keeping cookbooks consistent. Please check your commits against it, documenting rationale for disregarding recommendations.
Default Recipes
---------------
There should be no default recipes with the OpenStack cookbooks. This recommendation is because there are so many potential ways to deploy this, we should be explicit in defining what we mean. For example, should the default for Keystone be as a client of keystone or a server?
include_recipe
--------------
With the modular approach we're taking, include_recipe should probably be used sparingly. Explicit inclusion of the recipes we want to use should be used in roles instead.
Testing
=======