summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBen Bangert <ben@groovie.org>2014-04-21 15:20:06 -0700
committerBen Bangert <ben@groovie.org>2014-04-21 15:20:06 -0700
commit6ca193113479b13cd5d6f8e4fb5edf0f9112a03e (patch)
tree58a928efb2d334664b748f5c17d66cb2d8aef983
parent1576ccf6a19bb6374c3940108f985b6b3c67312c (diff)
downloadkazoo-6ca193113479b13cd5d6f8e4fb5edf0f9112a03e.tar.gz
- Add section on contributing recipes, add maintainer/status information for
existing recipes.
-rw-r--r--CHANGES.rst2
-rw-r--r--CONTRIBUTING.rst10
-rw-r--r--kazoo/recipe/barrier.py7
-rw-r--r--kazoo/recipe/counter.py7
-rw-r--r--kazoo/recipe/election.py7
-rw-r--r--kazoo/recipe/lock.py3
-rw-r--r--kazoo/recipe/partitioner.py3
-rw-r--r--kazoo/recipe/party.py3
-rw-r--r--kazoo/recipe/queue.py7
-rw-r--r--kazoo/recipe/watchers.py4
10 files changed, 48 insertions, 5 deletions
diff --git a/CHANGES.rst b/CHANGES.rst
index e9bee7d..4986bb7 100644
--- a/CHANGES.rst
+++ b/CHANGES.rst
@@ -52,6 +52,8 @@ API Changes
Documentation
*************
+- Add section on contributing recipes, add maintainer/status information for
+ existing recipes.
- Add note about alternate use of DataWatch.
1.3.1 (2013-09-25)
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index b618c0c..03c5389 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -62,6 +62,16 @@ If you introduce new functionality, please also add documentation and
a short entry in the top-level ``CHANGES.rst`` file.
+Adding Recipes
+==============
+
+New recipes are welcome, however they should include the status/maintainer
+RST information so its clear who is maintaining the recipe. This does mean
+that if you submit a recipe for inclusion with Kazoo, you should be ready
+to support/maintain it, and address bugs that may be found.
+
+Ideally a recipe should have at least two maintainers.
+
Legal
=====
diff --git a/kazoo/recipe/barrier.py b/kazoo/recipe/barrier.py
index 279f367..05addb4 100644
--- a/kazoo/recipe/barrier.py
+++ b/kazoo/recipe/barrier.py
@@ -1,4 +1,9 @@
-"""Zookeeper Barriers"""
+"""Zookeeper Barriers
+
+:Maintainer: None
+:Status: Unknown
+
+"""
import os
import socket
import uuid
diff --git a/kazoo/recipe/counter.py b/kazoo/recipe/counter.py
index 3fc80df..ed80f51 100644
--- a/kazoo/recipe/counter.py
+++ b/kazoo/recipe/counter.py
@@ -1,4 +1,9 @@
-"""Zookeeper Counter"""
+"""Zookeeper Counter
+
+:Maintainer: None
+:Status: Unknown
+
+"""
from kazoo.exceptions import BadVersionError
from kazoo.retry import ForceRetryError
diff --git a/kazoo/recipe/election.py b/kazoo/recipe/election.py
index 70ed56f..3089fa6 100644
--- a/kazoo/recipe/election.py
+++ b/kazoo/recipe/election.py
@@ -1,4 +1,9 @@
-"""ZooKeeper Leader Elections"""
+"""ZooKeeper Leader Elections
+
+:Maintainer: None
+:Status: Unknown
+
+"""
from kazoo.exceptions import CancelledError
diff --git a/kazoo/recipe/lock.py b/kazoo/recipe/lock.py
index 3b81382..2e6707c 100644
--- a/kazoo/recipe/lock.py
+++ b/kazoo/recipe/lock.py
@@ -1,5 +1,8 @@
"""Zookeeper Locking Implementations
+:Maintainer: None
+:Status: Unknown
+
Error Handling
==============
diff --git a/kazoo/recipe/partitioner.py b/kazoo/recipe/partitioner.py
index 7e1e25e..8de4231 100644
--- a/kazoo/recipe/partitioner.py
+++ b/kazoo/recipe/partitioner.py
@@ -1,5 +1,8 @@
"""Zookeeper Partitioner Implementation
+:Maintainer: None
+:Status: Unknown
+
:class:`SetPartitioner` implements a partitioning scheme using
Zookeeper for dividing up resources amongst members of a party.
diff --git a/kazoo/recipe/party.py b/kazoo/recipe/party.py
index 3a281ae..7186c10 100644
--- a/kazoo/recipe/party.py
+++ b/kazoo/recipe/party.py
@@ -1,5 +1,8 @@
"""Party
+:Maintainer: Ben Bangert <ben@groovie.org>
+:Status: Production
+
A Zookeeper pool of party members. The :class:`Party` object can be
used for determining members of a party.
diff --git a/kazoo/recipe/queue.py b/kazoo/recipe/queue.py
index f4a0d5d..c3e48d8 100644
--- a/kazoo/recipe/queue.py
+++ b/kazoo/recipe/queue.py
@@ -1,5 +1,8 @@
-"""
-Zookeeper based queue implementations.
+"""Zookeeper based queue implementations.
+
+:Maintainer: None
+:Status: Unknown
+
"""
import uuid
diff --git a/kazoo/recipe/watchers.py b/kazoo/recipe/watchers.py
index 05e7121..57a62d0 100644
--- a/kazoo/recipe/watchers.py
+++ b/kazoo/recipe/watchers.py
@@ -1,4 +1,8 @@
"""Higher level child and data watching API's.
+
+:Maintainer: Ben Bangert <ben@groovie.org>
+:Status: Production
+
"""
import logging
import time