Contributing
============

We welcome contributions to Randum! This guide will help you get started.

Getting Started
---------------

1. Fork the repository on GitHub
2. Clone your fork locally:

   .. code-block:: bash

      git clone https://github.com/yourusername/randum.git
      cd randum

3. Create a virtual environment and install dependencies:

   .. code-block:: bash

      python -m venv venv
      source venv/bin/activate  # On Windows: venv\Scripts\activate
      pip install -e .

Making Changes
--------------

1. Create a new branch for your changes:

   .. code-block:: bash

      git checkout -b feature/your-feature-name

2. Make your changes and test them thoroughly
3. Commit your changes with a clear commit message:

   .. code-block:: bash

      git commit -m "Add feature: description of your changes"

4. Push to your fork:

   .. code-block:: bash

      git push origin feature/your-feature-name

5. Open a Pull Request on GitHub

Code Style
----------

* Follow PEP 8 guidelines
* Use meaningful variable and function names
* Add docstrings to all public functions and classes
* Keep functions focused and concise

Testing
-------

Before submitting a pull request, make sure all tests pass:

.. code-block:: bash

   python -m pytest

Reporting Issues
----------------

If you find a bug or have a feature request, please open an issue on GitHub:
https://github.com/kactlabs/randum/issues

License
-------

By contributing to Randum, you agree that your contributions will be licensed under the MIT License.

Credits
-------

Randum is based on the excellent Faker library by joke2k and contributors.