Add Contribution Guide (elastic#595)

doordash · Feb 18, 2017 · f09ff5e · f09ff5e
1 parent 7d06d3c
commit f09ff5e
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 7 deletions.
diff --git a/CONTRIBUTING.md → CONTRIBUTING.rst b/CONTRIBUTING.md → CONTRIBUTING.rst
@@ -1,3 +1,6 @@
+Contribution Guide
+==================
+
 If you have a bugfix or new feature that you would like to contribute to
 elasticsearch-dsl-py, please find or open an issue about it first. Talk about what
 you would like to do. It may be that somebody is already working on it, or that
@@ -10,18 +13,18 @@ before writing too much code.
 
 The process for contributing to any of the Elasticsearch repositories is similar.
 
-1. Please make sure you have signed the [Contributor License
-   Agreement](http://www.elasticsearch.org/contributor-agreement/). We are not
+1. Please make sure you have signed the `Contributor License
+   Agreement <http://www.elasticsearch.org/contributor-agreement/>`_. We are not
    asking you to assign copyright to us, but to give us the right to distribute
    your code without restriction. We ask this of all contributors in order to
    assure our users of the origin and continuing existence of the code. You only
    need to sign the CLA once.
 
 2. Run the test suite to ensure your changes do not break existing code:
 
-    ````
-    python setup.py test
-    ````
+    .. code:: bash
+
+        $ python setup.py test
 
 3. Rebase your changes.
    Update your local repository with the most recent code from the main
@@ -37,4 +40,3 @@ The process for contributing to any of the Elasticsearch repositories is similar
 Then sit back and wait. There will probably be discussion about the pull
 request and, if any changes are needed, we would love to work with you to get
 your pull request merged into elasticsearch-dsl-py.
-
diff --git a/README b/README
@@ -265,6 +265,11 @@ Documentation
 
 Documentation is available at https://elasticsearch-dsl.readthedocs.io.
 
+Contribution Guide
+------------------
+
+Want to hack on Elasticsearch DSL? Awesome! We have `Contribution-Guide <https://github.com/elastic/elasticsearch-dsl-py/blob/master/CONTRIBUTING.rst>`_.
+
 License
 -------
 

diff --git a/docs/CONTRIBUTING.rst b/docs/CONTRIBUTING.rst
@@ -0,0 +1 @@
+../CONTRIBUTING.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -285,5 +285,5 @@ Contents
    persistence
    faceted_search
    api
+   CONTRIBUTING
    Changelog
-
-Original file line number
+Diff line change
@@ Expand Up / @@ -265,6 +265,11 @@ Documentation @@
     Documentation is available at https://elasticsearch-dsl.readthedocs.io.
+    Contribution Guide
+    ------------------
+    Want to hack on Elasticsearch DSL? Awesome! We have `Contribution-Guide <https://github.com/elastic/elasticsearch-dsl-py/blob/master/CONTRIBUTING.rst>`_.
     License
     -------
@@ Expand Down @@