От локального прототипа к передаче проекта
Другой человек запускает программу
На вашем компьютере всё работает. Вы передаёте папку знакомому, а он не знает версию Python, команду запуска и место хранения задач. Разработка не закончена, пока получателю приходится угадывать условия.
Для локального учебного приложения достаточно понятного README, чистого комплекта исходников и проверяемого запуска в новой папке. Это ещё не подготовка интернет-сервиса: публичный сервер, несколько пользователей, авторизация и эксплуатационные риски потребовали бы отдельного проекта.
Передача без случайных файлов
| Что включить | Зачем |
|---|---|
| Исходники и тесты | Воспроизвести поведение и проверки |
| Требуемую версию Python | Не угадывать совместимость |
| Команды запуска | Проверить обычный сценарий |
| Искусственный пример | Начать без настоящих данных |
| Ограничения | Понять, чего приложение не гарантирует |
Не включайте свой файл задач, .env, токены, журналы с личными данными и папки зависимостей без необходимости. .gitignore помогает отбирать файлы, но не проверяет содержимое уже отслеживаемых документов. Перед передачей просмотрите список и diff.
В учебном репозитории выполните:
git status --short
git diff
git ls-files
python3 check.pyСписок git ls-files показывает отслеживаемые файлы. Он не доказывает, что в них нет секретов. Откройте конфигурацию и примеры, посмотрите на содержимое. Если токен уже попал в историю, замените его у поставщика; история и резервные копии могут содержать старое значение.
Проверьте новую папку
Создайте отдельную копию исходников, исключая файл с вашими задачами. Пройдите README буквально, не пользуясь памятью. Запустите --help, добавление, чтение после нового запуска и общий комплект тестов. Если нужны команды, которых нет в README, допишите их.
Изменения кода сохраняйте осмысленными коммитами после просмотра. Когда нужно отменить уже сохранённое учебное изменение, git revert создаёт новый коммит с обратным изменением. Для совместного проекта это проще проследить, чем переписанную историю. История исходников не восстанавливает файлы задач, которые в неё не включались.
Данные требуют отдельного внимания
Перед опытом с импортом или новым форматом сделайте копию учебного JSON. После восстановления действительно откройте список и проверьте задачи. Наличие файла с названием backup ещё не доказывает, что его можно использовать.
Наш эталон не рассчитан на одновременную запись несколькими процессами и не обещает сохранность при прерывании записи. Это нужно явно указать получателю. Не добавляйте слово «production-ready» к отчёту агента без конкретных требований эксплуатации и их проверки.
Самостоятельное задание
Передайте учебный комплект другому человеку или пройдите инструкцию сами в новой папке. Запишите все места, в которых понадобилось дополнительное объяснение. Сделайте копию искусственных данных и проверьте восстановление из неё.
Критерии и разбор
Получатель воспроизводит сценарий по README. В переданном комплекте нет настоящих секретов и личных задач. Ограничения понятны: один пользователь, последовательные команды, локальный файл. Если никто кроме вас не проверял инструкцию, укажите это прямо; самостоятельная проверка не равна наблюдению за новичком.