.. include:: ../substitutions.rst

======
Issues
======

Thank you for helping improve the project by opening an issue. If you are thinking about reporting a bug or requesting a feature, please consider the following guidelines to enable efficient troubleshooting.


Bugs
----

The more information you can provide, the easier it is to address your issue. Relevant information to include in your issue is:

1. Python and |project| version.

2. A code-example or a detailed verbal description to reproduce your issue.

3. The full error log.

If possible, feel free to include a list of other installed Python packages in your environment by running

.. code-block:: bash

	pip list


Features
--------

When requesting a new feature, be sure to provide a clear rationale for why it would benefit the project. Describe the problem you're trying to solve and how the proposed feature would address it. If possible, include examples of how the featuer might be used and share your initial implementation.