Skip to content

CONTRIBUTING.ru.md

Latest commit

 

History

History
57 lines (46 loc) · 3.62 KB

CONTRIBUTING.ru.md

File metadata and controls

57 lines (46 loc) · 3.62 KB

Гайд по разработке (CONTRIBUTING)

Цели и стиль вклада (GitHub Flow)

Перед большими изменениями создавайте issue и согласуйте дизайн. Следуйте GitHub Flow: fork → branch → pull request → review → merge.

Где искать чем можно заняться

По проекту раскиданы комментарии, где как раз есть проблема или улучшение, которое вы можете решить, после решения удалите комментарий и отправьте коммит

Как добавить новый парсер

  1. Создайте файл в parsers/ с именем xxx.py и классом парсера, наследуемым от parsers.base.Parse.
  2. Держите селекторы и site-specific значения внутри файла парсера или в отдельной конфигурации.
  3. Зарегистрируйте обёртку в playcast/Parser.py через _run_parser("parsers.xxx", "ParseXxx", ...).

Требования к коммитам и PR

  • Пишите понятные сообщения коммитов (коротко: что и почему).
  • Один PR = одна логическая фича/фикс. Работайте в отдельной ветке (например, feature/ozon-parser).
  • Перед открытием PR убедитесь, что ветка актуальна относительно main (через rebase или merge).
  • При возможности добавляйте тесты или инструкции по ручной проверке.

Разработка с uv

Проект содержит uv.lock. Для управления зависимостями рекомендуется использовать uv:

  1. Установите uv по официальной инструкции.
  2. Синхронизируйте зависимости: 
    uv sync

Если вы предпочитаете стандартный venv:

python -m venv .venv
.venv\(\Scripts\Activate.\)ps1  # Windows PowerShell
pip install -U pip
pip install playwright beautifulsoup4 fake-useragent httpx lxml requests undetected-playwright playwright-stealth rebrowser-playwright
# или
pip install -r requirements.txt
python -m playwright install chromium

Быстрая проверка импорта обёрток

python -c "from playcast.Parser import ParseOzon; print('Import OK')"

Код-стайл и Лицензия

  • Соблюдайте PEP8, рекомендуется использовать black или ruff.
  • Проект под лицензией MIT. При добавлении стороннего кода убедитесь в совместимости лицензий.

Процесс PR/Review (коротко)

  1. Форкните репозиторий и создайте ветку в своём форке.
  2. Выполните изменения и протестируйте их.
  3. Обновите ветку относительно main и создайте PR.
  4. Опишите в PR цель, детали и метод тестирования. Ожидайте review.

Хотелось бы сказать что я не гуру программирования и не могу знать всё, если вы нашли способ решить какую-либо проблему лучше, скажите

Спасибо за вклад! 🙏