Ревью и исправление противоречий, опечаток, дубликатов #1
Loading…
Reference in a new issue
No description provided.
Delete branch "review-fixes"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Что сделано
Проведено полное ревью всех файлов репозитория. Найдены и исправлены:
AGENTS.md
researches/04-learning-outcomes.md(была потеряна)stakeholders/иметодики/в структуру репозиторияresearches/01-school-program.md
—для 8-9 классов, хотя в программе 9 класса (стр. 136-137) срезы строк явно указаны. Исправлено на+ (9 кл.)researches/02-university-courses.md
researches/03-employer-requirements.md
stakeholders/04-студент-первокурсник.md
методики/03-замена-c-на-python.md
Важные незакрытые проблемы (требуют обсуждения)
методики/02-структура-трёх-семестров.md) не покрывает темы, требуемые исследованиями: Django, FastAPI, Docker, Git — эти темы есть в требованиях работодателей и downstream-курсов, но не отражены в программеЧто поправлено: - AGENTS.md: добавлена секция Learning Outcomes со ссылкой на 04-learning-outcomes.md, добавлено описание папок stakeholders/ и методики/ в структуру репозитория - researches/01-school-program.md: срезы списков и строк исправлены с '—' на '+ (9 кл.)' (противоречие с программой 9 класса внутри файла) - researches/02-university-courses.md: уточнено, что детальный анализ только по ВШЭ, остальные вузы — обзорно (честность методологии) - researches/03-employer-requirements.md: убраны предписывающие формулировки ('курс должен' — это прерогатива методик, не исследования) - stakeholders/04-студент-первокурсник.md: формулировка начального уровня приведена в соответствие с 01-school-program.md (Python с 2021 года) - методики/03-замена-c-на-python.md: опечатка 'Быстрый прототипирование' → 'Быстрое прототипирование'Ретроспективное ревью PR #1 — «Рецензия и исправление противоречий, опечаток, дубликатов»
Что сделано хорошо
Чёткая идентификация проблем. Автор PR правильно нашёл реальные дефекты: несоответствие таблицы school-program фактической программе ФГОС (9 класс — срезы строк есть), расхождение между заявленным охватом 5 вузов и детальными ссылками только на ВШЭ, предписывающие формулировки в файле-исследовании, дубликат описания папок в AGENTS.md, противоречие в профиле студента-первокурсника, опечатка в методике.
Корректная фактология исправлений.
—→+ (9 кл.)— верно, программа 9 класса ФГОС (стр. 136-137) явно включает срезы строк.Хорошая структура PR body. Описание понятное, сгруппировано по файлам, указаны ссылки на источники и страницы. Проблема «незакрытые вопросы» вынесена отдельно — это ценно для ревьюеров, даже если они не были решены в рамках этого PR.
Минимальные и точные изменения. Diff компактен (24 строки добавлено, 16 удалено) — каждое изменение решает конкретную проблему, нет лишних правок.
Что можно было сделать лучше
Дубликат в AGENTS.md. После добавления структурированного списка папок (
researches/,stakeholders/,методики/) осталась строка «Папкаresearches/содержит исследования...» — она теперь частично дублирует первый пункт списка. Лучше было либо убрать эту строку, либо переформулировать как более общее примечание об этапах.AGENTS.md: «Подходы» и Learning Outcomes. Секция Learning Outcomes добавлена как заголовок второго уровня между Downstream-дисциплинами и Требованиями работодателей. Это логично, но секция «Подходы» (строки 113-116) визуально «выпадает» — она между Требованиями работодателей и Структурой репозитория, не имеет содержательной переклички с соседними разделами. Это не ошибка PR, но структура AGENTS.md в целом остаётся рыхлой.
Проблема 3-го семестра вынесена, но не решена. В body PR справедливо отмечено, что структура 3-го семестра не покрывает Django, FastAPI, Docker, Git. Это важный finding, но следовало бы создать отдельную задачу/issue в трекере, а не просто упомянуть в описании PR.
Мелкое замечание по стилю: в AGENTS.md после секции «Learning Outcomes» нет поясняющего текста — только «Источник: researches/04-learning-outcomes.md». Это минималистично, но для читателя, который не знаком с файлом, стоило бы добавить одну строку-пояснение (как это сделано для других секций).
Итоговая оценка
Хорошо (7/10). PR добросовестно устраняет реальные дефекты: опечатки, фактологические неточности, противоречия. Каждое изменение обосновано и ссылается на источники. Diff небольшой и аккуратный.
Минус за оставшийся дубликат в AGENTS.md и за то, что выявленная проблема с программой 3-го семестра не получила никакого трекинга за пределами описания PR.
Рекомендация: исправить дубликат в AGENTS.md (убрать или переформулировать строку «Папка
researches/содержит исследования...») — изменение на 1 строку.