summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorClay Gerrard <clay.gerrard@gmail.com>2015-03-26 21:43:48 -0700
committerThiago da Silva <thiago@redhat.com>2015-03-27 13:13:31 -0400
commitcf21db4bc68aff190c55d416b406a44bf204ba36 (patch)
tree9efcfb741b8e8b9a5ee6aa02634609b169494136
parenteb6a4cbec5dbd74b169f49ebc2083f2857b9bd28 (diff)
downloadswift-cf21db4bc68aff190c55d416b406a44bf204ba36.tar.gz
Add Swift Design Principles to CONTRIBUTING.md
This is based of work started a few design summits ago [1]. With EC getting close I felt like I could the inspiration. 1. https://etherpad.openstack.org/p/juno_swift_core_principles Change-Id: I90fa56d67003080fe3d7bc4e0fad053e3b0c8504 Signed-off-by: Thiago da Silva <thiago@redhat.com>
-rw-r--r--CONTRIBUTING.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 7ba46daf9..6a81d6a8c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -11,6 +11,29 @@ we won't be able to respond to pull requests submitted through GitHub.
Bugs should be filed [on Launchpad](https://bugs.launchpad.net/swift),
not in GitHub's issue tracker.
+
+Swift Design Principles
+=======================
+
+ * [The Zen of Python](http://legacy.python.org/dev/peps/pep-0020/)
+ * Simple Scales
+ * Minimal dependencies
+ * Re-use existing tools and libraries when reasonable
+ * Leverage the economies of scale
+ * Small, loosely coupled RESTful services
+ * No single points of failure
+ * Start with the use case
+ * ... then design from the cluster operator up
+ * If you haven't argued about it, you don't have the right answer yet :)
+ * If it is your first implementation, you probably aren't done yet :)
+
+Please don't feel offended by difference of opinion. Be prepared to advocate
+for your change and iterate on it based on feedback. Reach out to other people
+working on the project on
+[IRC](http://eavesdrop.openstack.org/irclogs/%23openstack-swift/) or the
+[mailing list](http://lists.openstack.org/pipermail/openstack-dev/) - we want
+to help.
+
Recommended workflow
====================