| 1 |
.. _how-to-contribute: |
| 2 |
|
| 3 |
How to Contribute to Eventlet |
| 4 |
############################# |
| 5 |
|
| 6 |
.. include:: asyncio/warning.rst |
| 7 |
|
| 8 |
Contribution are welcome. |
| 9 |
|
| 10 |
You want to report something? Read :ref:`report-a-bug`. |
| 11 |
|
| 12 |
You want to propose changes? Read :ref:`propose-changes`. |
| 13 |
|
| 14 |
.. _report-a-bug: |
| 15 |
|
| 16 |
Report a Bug |
| 17 |
============= |
| 18 |
|
| 19 |
You find a bug and you want to report it? |
| 20 |
|
| 21 |
You simply have to `create a new github issue <https://github.com/eventlet/eventlet/issues>`_ |
| 22 |
where you describe your problem. |
| 23 |
|
| 24 |
Do not forget to provide technical details like: |
| 25 |
|
| 26 |
* the hub you use |
| 27 |
* the context of your bug |
| 28 |
* the error message you get |
| 29 |
* everything else that may help us to understand your problem. |
| 30 |
|
| 31 |
The more you give details, the more we will be able to help you. |
| 32 |
|
| 33 |
.. _propose-changes: |
| 34 |
|
| 35 |
Propose Changes |
| 36 |
=============== |
| 37 |
|
| 38 |
You may want to propose changes to fix a bug, improve the documentation, etc. |
| 39 |
|
| 40 |
Feel free to open a pull request: https://github.com/eventlet/eventlet/pulls |
| 41 |
|
| 42 |
.. include:: asyncio/warning.rst |
| 43 |
|
| 44 |
We will be happy to review it. |
| 45 |
|
| 46 |
At this point you may be also interested by :ref:`how to test Eventlet <testing-eventlet>`. |