Skip to content
Permalink
Browse files

Add Contribution Guide (#595)

  • Loading branch information...
trishnaguha authored and HonzaKral committed Feb 18, 2017
1 parent 7d06d3c commit f09ff5e747f6320d59fde7b097427e1536962440
Showing with 15 additions and 7 deletions.
  1. +8 −6 CONTRIBUTING.md → CONTRIBUTING.rst
  2. +5 −0 README
  3. +1 −0 docs/CONTRIBUTING.rst
  4. +1 −1 docs/index.rst
@@ -1,3 +1,6 @@
Contribution Guide
==================

If you have a bugfix or new feature that you would like to contribute to 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 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 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. The process for contributing to any of the Elasticsearch repositories is similar.


1. Please make sure you have signed the [Contributor License 1. Please make sure you have signed the `Contributor License
Agreement](http://www.elasticsearch.org/contributor-agreement/). We are not 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 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 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 assure our users of the origin and continuing existence of the code. You only
need to sign the CLA once. need to sign the CLA once.


2. Run the test suite to ensure your changes do not break existing code: 2. Run the test suite to ensure your changes do not break existing code:


```` .. code:: bash
python setup.py test
```` $ python setup.py test
3. Rebase your changes. 3. Rebase your changes.
Update your local repository with the most recent code from the main 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 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 request and, if any changes are needed, we would love to work with you to get
your pull request merged into elasticsearch-dsl-py. your pull request merged into elasticsearch-dsl-py.

5 README
@@ -265,6 +265,11 @@ Documentation


Documentation is available at https://elasticsearch-dsl.readthedocs.io. 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 License
------- -------


@@ -285,5 +285,5 @@ Contents
persistence persistence
faceted_search faceted_search
api api
CONTRIBUTING
Changelog Changelog

0 comments on commit f09ff5e

Please sign in to comment.
You can’t perform that action at this time.