From f095bcde105690a819134c79ddae3e5813bff58d Mon Sep 17 00:00:00 2001 From: mattray Date: Thu, 26 Jul 2012 15:59:09 -0500 Subject: [PATCH] capturing some thoughts on making the repo more modular and accessible --- documentation/style-guide.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 documentation/style-guide.md diff --git a/documentation/style-guide.md b/documentation/style-guide.md new file mode 100644 index 0000000..334967e --- /dev/null +++ b/documentation/style-guide.md @@ -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 +=======