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>
This commit is contained in:
parent
eb6a4cbec5
commit
cf21db4bc6
@ -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),
|
Bugs should be filed [on Launchpad](https://bugs.launchpad.net/swift),
|
||||||
not in GitHub's issue tracker.
|
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
|
Recommended workflow
|
||||||
====================
|
====================
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user