.. _contributing:

Contributing Guidelines
=======================

We appreciate your interest in contributing to this project! Whether you found a bug, have a suggestion, or want to add new features, your input is welcome.

How to Contribute
-----------------

1. **Fork the Repository**

   Create your own copy of the repository on GitHub.

2. **Create a Feature Branch**

   Use a descriptive name for your branch:
    
    .. code-block:: bash

        git checkout -b fix/typo-in-readme

3. **Make Changes**

    Follow the coding style and ensure existing functionality is not broken. Add tests if relevant.

4. **Submit a Pull Request**

    Push your branch and open a pull request on GitHub. Include a clear description of your changes.

5. **Wait for Review**

    We’ll review your PR and may request changes or offer suggestions.

Coding Style
------------

- Follow **PEP8** standards for Python code.
- Use **docstrings** (PEP257) for public classes, functions, and modules.
- Include **type hints** where appropriate.
- Keep commits clean and descriptive.

Bug Reports & Feature Requests
------------------------------

- Use GitHub Issues to report bugs or suggest new features.
- Include steps to reproduce, error messages, or use cases when possible.

Code of Conduct
---------------

We strive to maintain a respectful and inclusive community. Please follow our :doc:`code of conduct <code_of_conduct>` when interacting.

Thank You
---------

Your contributions help improve the project and support the community — thank you!