summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.rst
diff options
context:
space:
mode:
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r--CONTRIBUTING.rst18
1 files changed, 18 insertions, 0 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
new file mode 100644
index 00000000..6a89e73f
--- /dev/null
+++ b/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