Thank you for your interest in contributing! Here are some guidelines to help you get started.
- Follow PEP 8 style guidelines
- Use type hints for all functions
- Write descriptive docstrings
- Keep lines under 120 characters
- Write tests for new features
- Run pytest before submitting PRs
- Aim for 80%+ code coverage
- Test edge cases and error conditions
- Use clear, descriptive commit messages
- Start with a verb (Add, Fix, Update, etc.)
- Include issue numbers when relevant
- Example: "Add type hints to download_texts_improved.py (#16)"
- Create a new branch for each PR
- Link related issues in the PR description
- Ensure CI/CD checks pass
- Request review from maintainers
- Be prepared to address feedback