1.7 KiB
1.7 KiB
CONTRIBUTING
Спасибо за желание помочь проекту tg-ws-proxy.
Перед созданием issue
- Проверьте документацию в
docs/README.md. - Убедитесь, что похожий issue еще не открыт.
- Для корректной работы triage используйте стандартные лейблы из
.github/labels.md.
Как сообщать о проблемах
- Используйте шаблон
Проблема. - По возможности укажите:
- версию приложения,
- ОС,
- шаги воспроизведения,
- ожидаемое и фактическое поведение,
- лог-файл или текст ошибки.
Чем точнее описание, тем быстрее можно помочь.
Локальный запуск из исходников
Требуется Python >=3.8.
pip install -e .
Запуск:
- консольный режим:
tg-ws-proxy - Windows tray:
tg-ws-proxy-tray-win - macOS tray:
tg-ws-proxy-tray-macos - Linux tray:
tg-ws-proxy-tray-linux
Подробности: docs/BuildFromSource.md.
Pull Request
Перед открытием PR:
- Убедитесь, что изменение решает конкретную проблему.
- Проверьте, что не сломаны существующие сценарии.
- Обновите документацию, если меняется поведение или настройка.
Небольшие и сфокусированные PR проверяются и принимаются быстрее.