.. _contribution:

***********************
Contribution Guidelines
***********************


Submit a new Feature
--------------------

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can
also simply open an issue with the tag :bdg-primary-line:`enhancement`.

Next, you can follow this checklist:

    1. Fork the Project
    2. Create your Feature Branch (:code:`git checkout -b feature/AmazingFeature`)
    3. Commit your Changes (:code:`git commit -m 'Add some AmazingFeature'`)
    4. Push to the Branch (:code:`git push origin feature/AmazingFeature`)
    5. Open a Pull Request

.. tip::
    If you still need some time developing your feature, you can mark your pull request as a draft.


Submit an Issue
---------------

Feel free to open up any issues you've encoutered. Please describe what happend and provide the detailed
exception traceback.

Running Tests
-------------

Tests were developed using :code:`pytest` and can be executed using either :code:`tox` or :code:`pytest`:

.. code-block:: console

    $ tox # or just 'pytest'


Having a general question?
--------------------------

Just ask! You can either use `Discussions <https://github.com/MatrixEditor/caterpillar/discussions>`_ or
`Github Issues <https://github.com/MatrixEditor/caterpillar/issues>`_.