51 lines
5.0 KiB
Markdown
51 lines
5.0 KiB
Markdown
|
# Репозиторий команды
|
||
|
|
|
||
|
|
Каждая команда ведёт отдельный публичный Git-репозиторий. Он должен поддерживать PR/MR, а преподаватель должен иметь возможность открыть страницу PR/MR и оставить общий или построчный комментарий. Конкретный сервис команда выбирает самостоятельно.
|
||
|
|
|
||
|
|
Репозиторий материалов курса редактирует преподаватель. Команда один раз передаёт адрес своего репозитория через основной канал курса, после чего преподаватель добавляет его в [карточку проекта](projects/README.md). Изменения проекта команда вносит в свой репозиторий; дополнительные формы для передачи материалов не используются.
|
||
|
|
|
||
|
|
До первой сдачи команда проверяет, что преподавателю доступны репозиторий, PR/MR и оба вида комментариев.
|
||
|
|
|
||
|
|
## Обязательные файлы
|
||
|
|
|
||
|
|
Корневой `README.md` содержит:
|
||
|
|
|
||
|
|
- название проекта и ссылку на назначенное задание;
|
||
|
|
- полные имена участников;
|
||
|
|
- сокращённую инструкцию запуска;
|
||
|
|
- навигацию по коду, данным и материалам в `nis/`.
|
||
|
|
|
||
|
|
Каталог `nis/` включает:
|
||
|
|
|
||
|
|
- `project.md` — выбранный технический путь, детализацию обязательного результата, поддерживаемые сценарии, упрощения и критерии завершённости;
|
||
|
|
- `experiment-plan.md` — baseline, данные или нагрузки, конфигурации, метрики, параметры, серии, повторы, проверку корректности и обработку результатов;
|
||
|
|
- `checkpoints/01.md`, `02.md`, `03.md` — результаты этапов, проверяемые свидетельства и ответственность участников;
|
||
|
|
- `status.md` — состояние обязательной работы, риски, оставшиеся задачи, сроки и ответственных;
|
||
|
|
- `results.md` — конфигурации, исходные и обработанные данные, команды построения результатов, внешние ссылки и контрольные суммы;
|
||
|
|
- `final.md` — лист итоговой сдачи.
|
||
|
|
|
||
|
|
Код, тесты и данные располагаются с учётом устройства конкретного проекта. Секреты и материалы без права публичного распространения в репозиторий не помещаются. Для начала работы можно скопировать [готовый шаблон](project-repository-template/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. В преподавательской карточке проекта фиксируются полный хеш, статус и ссылка на итоговый комментарий.
|