69 lines (51 loc) · 1.63 KB

Contributing to Promptizer

Thank you for your interest in contributing to Promptizer! This document provides guidelines and instructions for contributing.

How to Contribute

Reporting Bugs

If you find a bug, please open an issue with:

A clear description of the bug
Steps to reproduce
Expected vs actual behavior
Your environment (Python version, OS, etc.)
Error messages or logs (if applicable)

Suggesting Features

We welcome feature suggestions! Please open an issue with:

A clear description of the feature
Use cases and examples
Potential implementation approach (if you have ideas)

Pull Requests

Fork the repository
Create a feature branch (git checkout -b feature/amazing-feature)
Make your changes
Add tests if applicable
Ensure code follows the existing style
Update documentation if needed
Commit your changes (git commit -m 'Add amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

Development Setup

Clone the repository:

git clone https://github.com/igor-olikh/promptizer.git
cd promptizer

Install dependencies:
```
poetry install
```

Create a .env file with your API keys:

cp .env.example .env
# Edit .env and add your keys

Run tests (when available):
```
poetry run pytest
```

Code Style

Follow PEP 8 style guidelines
Use type hints where appropriate
Add docstrings to functions and classes
Keep functions focused and small

License

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