Как выполнять публичные домашние задания
Каждое задание в этом разделе можно выполнить независимо от остальных. Приватный учебный репозиторий, доступ к чужим веткам и назначенный reviewer не требуются.
Перед началом
- Прочитайте выбранное задание целиком и выпишите вопросы к требованиям.
- Создайте собственный публичный репозиторий на GitHub или отдельную папку в существующем учебном репозитории.
- Добавьте
README.mdс названием задания, инструкцией запуска и принятыми решениями. - Настройте окружение по инструкции по старту работы.
Рекомендуемый Git-процесс
Git-процесс нужен для практики, но не является условием доступа к заданию.
- Создайте ветку от своей основной ветки:
feature/<task-name>. - Делайте небольшие осмысленные commits.
- Отправьте ветку в свой репозиторий и откройте pull request в собственную
main. - Перед merge самостоятельно проверьте diff, описание PR и результаты тестов.
Если вы пока не используете pull requests, можно выполнить задание непосредственно в своём репозитории и сохранить историю commits.
Что должно быть в результате
- исходный код без секретов и локальных
.env; README.mdс командами установки, запуска и тестирования;- файл зависимостей и воспроизводимое окружение;
- автоматические тесты для основных и ошибочных сценариев;
- краткое описание спорных решений и известных ограничений;
- успешный запуск линтера, форматтера и тестов.
Самопроверка
Перед завершением задания ответьте себе на вопросы:
- Можно ли запустить проект на чистой машине по одному README?
- Понятно ли из названий и структуры кода, где находится бизнес-логика?
- Проверяются ли тестами ошибки, а не только успешный сценарий?
- Нет ли в истории и файлах паролей, токенов или других секретов?
- Можете ли вы объяснить каждое нетривиальное решение своими словами?
Ссылку на готовую работу можно отправить любому наставнику или использовать как часть портфолио, но специальный канал сдачи и обязательный reviewer для выполнения материала не нужны.