Add specs directory for design discussion/review

[multicloud/framework.git] / docs / specs / README.rst

diff --git a/docs/specs/README.rst b/docs/specs/README.rst
new file mode 100644 (file)
index 0000000..6429d1f
--- /dev/null
+++ b/docs/specs/README.rst
@@ -0,0 +1,28 @@
+INTRO
+=====
+
+This directory holds the proposals of non-trivial changes to multicloud. We host
+them here to avoid the potential headaches in managing yet another project,
+say `multicloud-specs`. When the needs rise up for a dedicated project for
+proposals, we can create such a project and migrate things here.
+
+
+DIRECTORY LAYOUT
+================
+
+Proposals will be put into this directory during review. After being reviewed,
+it will be migrated into the `rejected` subdirectory or the `approved`
+subdirectory respectively.
+
+
+rejected
+--------
+
+A subdirectory for proposals that were rejected.
+
+
+approved
+--------
+
+A subdirectory for proposals that were approved.
+