Publish team projects. Improve project checkpoint and task description.
This commit is contained in:
@@ -17,13 +17,17 @@
|
||||
|
||||
Каталог `nis/` включает:
|
||||
|
||||
- `project.md` — выбранный технический путь, детализацию обязательного результата, поддерживаемые сценарии, упрощения и критерии завершённости;
|
||||
- `project.md` — выбранный технический путь, ожидаемые результаты и способы их проверки, поддерживаемые сценарии и упрощения;
|
||||
- `experiment-plan.md` — baseline, данные или нагрузки, конфигурации, метрики, параметры, серии, повторы, проверку корректности и обработку результатов;
|
||||
- `checkpoints/01.md`, `02.md`, `03.md` — результаты этапов, проверяемые свидетельства и ответственность участников;
|
||||
- `status.md` — состояние обязательной работы, риски, оставшиеся задачи, сроки и ответственных;
|
||||
- `results.md` — конфигурации, исходные и обработанные данные, команды построения результатов, внешние ссылки и контрольные суммы;
|
||||
- `final.md` — лист итоговой сдачи.
|
||||
|
||||
Для каждой сдачи заполняйте файлы, указанные в её описании. К [первой точке](project-checkpoints/01-project-plan.md) нужны `project.md`, `experiment-plan.md` и `checkpoints/01.md` со ссылками на материалы проверок. Остальные материалы добавляйте по мере работы. В инструкции запуска в `README.md` к первой точке достаточно команд технических проверок или ссылки на них; сквозной запуск добавляется ко второй точке.
|
||||
|
||||
Заменяйте пояснения в квадратных скобках своим текстом. Общее описание проекта и план эксперимента обновляйте по мере работы; в файлах точек сохраняйте итоги соответствующего этапа. Команды, конфигурации и данные достаточно описать в одном месте и дать на них ссылки из остальных файлов.
|
||||
|
||||
Код, тесты и данные располагаются с учётом устройства конкретного проекта. Секреты и материалы без права публичного распространения в репозиторий не помещаются. Для начала работы можно скопировать [готовый шаблон](project-repository-template/README.md).
|
||||
|
||||
## Сдача через PR/MR
|
||||
|
||||
Reference in New Issue
Block a user