Contributing

Thanks for your interest in contributing to TStrends! This is a project developed in my free time, and I welcome any contributions or feedback.

Getting Started

1. Setup

Clone the repository and install in development mode:

git clone https://github.com/agpenas/tstrends.git
cd tstrends
pip install -e .

For development, install the additional dependencies:

pip install -r requirements-dev.txt

Basic Guidelines

  • Try to follow the existing code style (PEP 8)

  • Add docstrings for new functions

  • Include type hints where appropriate

  • Add tests for new functionality

Making Changes

  1. Create a branch for your changes

  2. Make your changes

  3. Run the tests with pytest

  4. Submit a pull request

Need Help?

If you have questions or suggestions:

  • Open an issue on GitHub

  • Reach out directly

Your contributions will be licensed under the BSD-2-Clause License.