nis2/project-repository.md

Репозиторий команды

Каждая команда ведёт отдельный Git-репозиторий с поддержкой PR/MR. Он может быть публичным или закрытым. Конкретный сервис команда выбирает самостоятельно.

Предоставьте преподавателю доступ к репозиторию и возможность оставлять общие и построчные комментарии в PR/MR. Аккаунты преподавателя: GitHub — osukhoroslov, GitLab — sol. Для публичного репозитория с открытыми комментариями отдельно добавлять преподавателя в участники не требуется.

Если при проверке материалы окажутся недоступны, преподаватель свяжется с представителем команды через Telegram, указанный в форме регистрации, и запросит доступ.

Регистрация репозитория

До 4 ноября 2026 года, 00:30 (МСК) один представитель команды заполняет форму регистрации репозитория. При повторной отправке учитывается последний ответ команды.

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

Обязательные файлы

Корневой README.md содержит:

• название проекта и ссылку на назначенное задание;
• полные имена участников;
• сокращённую инструкцию запуска;
• навигацию по коду, данным и материалам в nis/.

Каталог nis/ включает:

• project.md — выбранный технический путь, ожидаемые результаты и способы их проверки, поддерживаемые сценарии и упрощения;
• experiment-plan.md — baseline, данные или нагрузки, конфигурации, метрики, параметры, серии, повторы, проверку корректности и обработку результатов;
• checkpoints/01.md, 02.md, 03.md — результаты этапов, проверяемые свидетельства и ответственность участников;
• status.md — состояние обязательной работы, риски, оставшиеся задачи, сроки и ответственных;
• results.md — конфигурации, исходные и обработанные данные, команды построения результатов, внешние ссылки и контрольные суммы;
• final.md — лист итоговой сдачи.

Для каждой сдачи заполняйте файлы, указанные в её описании. К первой точке нужны project.md, experiment-plan.md и checkpoints/01.md со ссылками на материалы проверок. Остальные материалы добавляйте по мере работы. В инструкции запуска в README.md к первой точке достаточно команд технических проверок или ссылки на них; сквозной запуск добавляется ко второй точке.

Заменяйте пояснения в квадратных скобках своим текстом. Общее описание проекта и план эксперимента обновляйте по мере работы; в файлах точек сохраняйте итоги соответствующего этапа. Команды, конфигурации и данные достаточно описать в одном месте и дать на них ссылки из остальных файлов.

Код, тесты и данные располагаются с учётом устройства конкретного проекта. Секреты и материалы без права публичного распространения в репозиторий не помещаются. Для начала работы можно скопировать готовый шаблон.

Сдача через PR/MR

Сдача	Ветка
Первая контрольная точка	nis/checkpoint-1
Вторая контрольная точка	nis/checkpoint-2
Третья контрольная точка	nis/checkpoint-3
Сверка состояния проекта	nis/status
Финальная версия	nis/final

Для каждой сдачи команда:

1. создаёт указанную ветку от актуальной main;
2. к сроку публикует ветку и открывает PR/MR в main;
3. указывает в описании полный хеш сдаваемого коммита, краткий результат и ссылки на соответствующие файлы в nis/;
4. после срока не перебазирует ветку и не выполняет force-push;
5. добавляет исправления новыми коммитами в ту же ветку;
6. объединяет PR/MR с main после проверки преподавателем.

Срок соблюдён, если к нему опубликован указанный коммит и открыт PR/MR. Преподаватель проверяет коммит, зафиксированный в описании PR/MR. Исправления, перенесённые на следующий этап, отражаются в следующей ветке и файле контрольной точки.

Подробная обратная связь остаётся в PR/MR. В преподавательской карточке проекта фиксируются полный хеш, статус и ссылка на итоговый комментарий.