Skip to content

Commit f09ff5e

Browse files
trishnaguhahonzakral
authored andcommitted
Add Contribution Guide (elastic#595)
1 parent 7d06d3c commit f09ff5e

File tree

4 files changed

+15
-7
lines changed

4 files changed

+15
-7
lines changed

CONTRIBUTING.md renamed to CONTRIBUTING.rst

+8-6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
Contribution Guide
2+
==================
3+
14
If you have a bugfix or new feature that you would like to contribute to
25
elasticsearch-dsl-py, please find or open an issue about it first. Talk about what
36
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.
1013

1114
The process for contributing to any of the Elasticsearch repositories is similar.
1215

13-
1. Please make sure you have signed the [Contributor License
14-
Agreement](http://www.elasticsearch.org/contributor-agreement/). We are not
16+
1. Please make sure you have signed the `Contributor License
17+
Agreement <http://www.elasticsearch.org/contributor-agreement/>`_. We are not
1518
asking you to assign copyright to us, but to give us the right to distribute
1619
your code without restriction. We ask this of all contributors in order to
1720
assure our users of the origin and continuing existence of the code. You only
1821
need to sign the CLA once.
1922

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

22-
````
23-
python setup.py test
24-
````
25+
.. code:: bash
26+
27+
$ python setup.py test
2528
2629
3. Rebase your changes.
2730
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
3740
Then sit back and wait. There will probably be discussion about the pull
3841
request and, if any changes are needed, we would love to work with you to get
3942
your pull request merged into elasticsearch-dsl-py.
40-

README

+5
Original file line numberDiff line numberDiff line change
@@ -265,6 +265,11 @@ Documentation
265265

266266
Documentation is available at https://elasticsearch-dsl.readthedocs.io.
267267

268+
Contribution Guide
269+
------------------
270+
271+
Want to hack on Elasticsearch DSL? Awesome! We have `Contribution-Guide <https://github.com/elastic/elasticsearch-dsl-py/blob/master/CONTRIBUTING.rst>`_.
272+
268273
License
269274
-------
270275

docs/CONTRIBUTING.rst

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../CONTRIBUTING.rst

docs/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -285,5 +285,5 @@ Contents
285285
persistence
286286
faceted_search
287287
api
288+
CONTRIBUTING
288289
Changelog
289-

0 commit comments

Comments
 (0)