summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.rst
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-27 18:24:20 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-27 18:24:20 +0000
commit483eb2f56657e8e7f419ab1a4fab8dce9ade8609 (patch)
treee5d88d25d870d5dedacb6bbdbe2a966086a0a5cf /CONTRIBUTING.rst
parentInitial commit. (diff)
downloadceph-483eb2f56657e8e7f419ab1a4fab8dce9ade8609.tar.xz
ceph-483eb2f56657e8e7f419ab1a4fab8dce9ade8609.zip
Adding upstream version 14.2.21.upstream/14.2.21upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
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