Contributing

We welcome contributions to the Podcast Teaser Generator! This document provides guidelines and instructions for contributing to the project.

Ways to Contribute

Clone your fork locally:

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

Create a virtual environment and install development dependencies:

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

Create a new branch for your feature or bugfix:
```
git checkout -b feature/your-feature-name
```

Make your changes and commit them with clear, descriptive messages:

git commit -m "Add feature X" -m "This implements feature X which solves problem Y"

Push to your fork:

git push origin feature/your-feature-name

Open a pull request from your fork to the main repository
Make sure your PR includes:
- A clear description of the changes
- Any relevant documentation updates
- Tests if applicable
- Updates to the CHANGELOG.md file if needed

When adding new features or fixing bugs, please include appropriate tests. Run the existing tests to make sure your changes don’t break anything:

pytest

To build the documentation locally:

Install Sphinx and the ReadTheDocs theme:
```
pip install sphinx sphinx_rtd_theme
```
Build the documentation:
```
cd docs
make html
```
View the documentation by opening _build/html/index.html in your browser

When reporting bugs, please include:

Feature requests are welcome! Please provide:

Please be respectful and considerate of others when contributing. We aim to foster an inclusive and welcoming community.