initial code repo

[stor4nfv.git] / src / ceph / CONTRIBUTING.rst

diff --git a/src/ceph/CONTRIBUTING.rst b/src/ceph/CONTRIBUTING.rst
new file mode 100644 (file)
index 0000000..6a89e73
--- /dev/null
+++ b/src/ceph/CONTRIBUTING.rst
@@ -0,0 +1,18 @@
+For the general process of submitting patches to ceph, read the below
+
+`Submitting Patches`_
+
+For documentation patches the following guide will help you get started
+
+`Documenting Ceph`_
+
+Performance enhancements must come with test data and detailed
+explanations.
+
+Code cleanup is appreciated along with a patch that fixes a bug or
+implements a feature. Except on rare occasions, code cleanup that only
+involve coding style or whitespace modifications are discouraged,
+primarily because they cause problems when rebasing and backporting.
+
+.. _Submitting Patches: SubmittingPatches.rst
+.. _Documenting Ceph:  doc/start/documenting-ceph.rst