From 09f33fb5dfb04d74313cdd96295d9a29c54f0669 Mon Sep 17 00:00:00 2001 From: Spencer Krum Date: Wed, 29 Apr 2015 01:46:04 -0700 Subject: [PATCH] Add developer guidelines Change-Id: Idf04135bb8037fdc3e9cb6e65e53654524abfabf --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index d63819f..62bdee8 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,13 @@ ## Overview Configures an OpenStack Continuous Integration System + +## Developing + +If you are adding features to this module, first ask yourself: "Does this logic +belong in the module for the service?" + +An example of this is the gearman-logging.conf file needed by the zuul service. +This file should be managed by the zuul module, not managed here. What should go +in this module is high level directives and integrations such as a list of +jenkins plugins to install or a class that instantiates multiple services.