]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc: Add a contributing file at the root of repo 2408/head
authorAbhishek Lekshmanan <abhishek.lekshmanan@gmail.com>
Fri, 5 Sep 2014 18:04:17 +0000 (23:34 +0530)
committerAbhishek Lekshmanan <abhishek.lekshmanan@gmail.com>
Fri, 5 Sep 2014 18:53:24 +0000 (00:23 +0530)
Github shows up a `guidelines for contributing` while opening a new pull
request for any repository with a CONTRIBUTING file at the repo
root, which allows for a quick overview to contribute to the
repository.

Currently this file just links to the Submitting Patches and the
documentation start guide.

Signed-off-by: Abhishek Lekshmanan <abhishek.lekshmanan@gmail.com>
CONTRIBUTING.rst [new file with mode: 0644]

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
new file mode 100644 (file)
index 0000000..ed7e4ea
--- /dev/null
@@ -0,0 +1,10 @@
+For the general process of submitting patches to ceph, read the below
+
+`Submitting Patches`_
+
+For documentation patches the the following guide will help you get started
+
+`Documenting Ceph`_
+
+.. _Submitting Patches: SubmittingPatches
+.. _Documenting Ceph:  doc/start/documenting-ceph.rst