CONTRIBUTING - master - Max_Cherep/super-resolution

CONTRIBUTING
45 строк3 KB
maxim.cherepanov
Add GitVerse community files and README onboarding links.
10 июл 2026, 21:06
10 июл 2026, 21:06ff45963
# Участие в проекте

Спасибо за интерес к super-resolution. Проект в основном ведётся одним автором, но предложения и исправления приветствуются.

## Как предложить изменение

1. Проверьте [Issues](https://gitverse.ru/Max_Cherep/super-resolution/issues) — возможно, тема уже обсуждается.
2. Для нетривиальных правок сначала создайте issue с кратким описанием задачи.
3. Форкните репозиторий, внесите изменения в отдельной ветке.
4. Откройте запрос на слияние в `master` с понятным описанием.

## Запрос на слияние

В описании укажите:

- **Что** изменено и **зачем**
- **Как проверить** (команды, сценарий в Web UI)
- Связанный issue (если есть)

Чек-лист перед отправкой:

- [ ] Изменения локально проверены (`make up` или затронутый компонент)
- [ ] Дифф минимален — без несвязанного рефакторинга
- [ ] Секреты (`.env`, токены) не попали в коммит
- [ ] `vendor/FlashSR/` не меняется без веской причины

## Стиль кода

- Python: следовать существующему стилю файла; публичные функции в модулях — `snake_case`, константы — `UPPER_SNAKE_CASE`
- Web: шаблоны Jinja2 + HTMX, без лишнего JS
- Коммиты: краткое сообщение на английском, смысл в первой строке
- Не переименовывать HAL/CubeMX-стиль функций в `vendor/`

## Тесты

Автотестов пока нет. Для изменений в worker/web опишите ручную проверку в PR. Для `MOCK_MODE=1` достаточно прогона UI без GPU.

## Ревью

Ответ на PR — по возможности в течение нескольких дней. Мелкие фиксы могут быть приняты быстрее.

## Вопросы

- Issues в репозитории: [gitverse.ru/Max_Cherep/super-resolution](https://gitverse.ru/Max_Cherep/super-resolution)
- Подробный план разработки: [PLAN.md](PLAN.md)