Files
olcrtc/.github/PULL_REQUEST_TEMPLATE.md

79 lines
3.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!--
Спасибо за PR.
Перед отправкой убедись:
- Заголовок в формате Conventional Commits: feat(scope): ..., fix(scope): ..., refactor(scope): ..., docs(scope): ...
- PR делает одну вещь.
- Прогнаны линтер и тесты (mage lint, mage test, go vet, golangci-lint).
- Чувствительные значения (ключи, токены, room.id, креды) НЕ попали в код, тесты, конфиги, логи.
- Если меняешь публичный API в `pkg/` - это явно отмечено .
-->
## Что меняет PR
<!-- 13 предложения по сути изменений. -->
## Связанные issue
<!-- Closes #123, Refs #456. Если PR ничего не закрывает - напиши "нет". -->
## Тип изменения
- [ ] fix - исправление бага
- [ ] feat - новая функциональность
- [ ] refactor - рефакторинг без изменения поведения
- [ ] perf - улучшение производительности
- [ ] docs - только документация
- [ ] build / ci - сборка, CI, пакетирование
- [ ] chore - прочее (deps, форматирование и т.п.)
- [ ] BREAKING CHANGE - ломает совместимость (конфиг/wire/публичный API)
## Область
<!-- Отметь то, что затронуто. -->
- [ ] auth (`internal/auth/jitsi|telemost|wbstream`)
- [ ] transport / channel (`pkg/olcrtc/tunnel`, datachannel/vp8/sei/video)
- [ ] mux / control / liveness / lifecycle
- [ ] session / app (`internal/app/session`, `pkg/`)
- [ ] config / CLI / URI / sub
- [ ] mobile (`mobile/`)
- [ ] CI / Docker / mage
- [ ] docs / examples
- [ ] другое:
## Как тестировалось
<!--
Опиши: какой провайдер, транспорт, режим (srv/cnc), ОС, как воспроизводил before/after.
-->
- Provider: <!-- jitsi / telemost / wbstream / none -->
- Transport: <!-- datachannel / vp8channel / seichannel / videochannel -->
- ОС: <!-- linux/windows/macos/android/freebsd -->
- Сценарий:
```text
<команды / шаги / лог до и после>
```
## Совместимость
- [ ] Конфиг (`*.yaml`) совместим с предыдущей версией
- [ ] Wire-протокол совместим (клиент старой версии работает с новым сервером и наоборот)
- [ ] Публичный API в `pkg/` не сломан
<!-- Если что-то сломано - опиши миграцию явно. -->
## Чек-лист
- [ ] Локально прогнаны `mage lint` и `mage test`
- [ ] Добавлены/обновлены тесты, где это имеет смысл
- [ ] Обновлена документация (`docs/`, примеры в `docs/examples/`, README), если поведение/конфиг изменились
- [ ] В коде нет закомментированного мусора, отладочных `fmt.Println`, токенов и ключей
- [ ] Я согласен с лицензией репозитория и тем, что мой вклад выпускается под ней
## Дополнительно
<!-- Что ещё нужно знать ревьюеру: нерешённые TODO, известные ограничения, follow-up PR. -->