Skip to content

Latest commit

 

History

History
42 lines (35 loc) · 738 Bytes

CONTRIBUTING.md

File metadata and controls

42 lines (35 loc) · 738 Bytes

Contributing to Book Translator

Getting Started

  1. Fork repository
  2. Clone your fork
  3. Create feature branch

Development Setup

python -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Code Standards

  • Follow PEP 8
  • Use type hints
  • Write docstrings
  • Format with black
  • Sort imports with isort

Testing

  • Write tests for new features
  • Run existing tests before PR
  • Maintain >80% coverage

Pull Requests

  1. Update documentation
  2. Add tests
  3. Update CHANGELOG.md
  4. Create PR with description:
    • Changes made
    • Issue reference
    • Testing details

Commit Messages

  • Use present tense
  • Be descriptive
  • Reference issues

Questions

Open an issue or contact maintainers