Глава 23 · Часть II · Планируем SafeSort на GitHub

Как спланировать Project: лучшие практики

Project легко создать за секунду и так же легко захламить десятком неиспользуемых полей — несколько решений стоит принять заранее.

SafeSort · Часть 2 из 6Планирование

Создать Project — секундное дело; ошибка, которую совершает почти каждый новичок, — сразу добавить десяток полей и три представления «на будущее», а через месяц забросить большинство из них. Прежде чем нажать «New project», стоит принять несколько решений осознанно.

Решить область действия заранее

Project можно привязать к одному репозиторию или объединить в нём несколько. Для SafeSort ответ простой — один Project на один репозиторий, потому что вся работа этой главы происходит в Cartesian-School/safesort и нет смысла тянуть в один список задачи из других репозиториев курса.

Меньше полей — лучше

ВместоЛучше
поле «на всякий случай», которое никто не заполняетполе, отвечающее на конкретный вопрос (кто важнее, что за часть кода)
свободный текст там, где вариантов на самом деле немногоSingle select с заранее известным списком значений
новое представление для каждой идеи «а вдруг пригодится»одно-два представления, которые реально открывают каждый день
Статус — почти всегда достаточно одного поля для отслеживания прогресса
У GitHub Project уже есть встроенное поле Status. Прежде чем добавлять что-то ещё, стоит спросить: отвечает ли новое поле на вопрос, которого Status не покрывает? Для SafeSort это Priority (что делать в первую очередь) и Area (к какой части кода относится задача) — оба поля появятся дальше в этой части главы.

Поля и представления можно менять позже

Ничего из решённого на этом шаге не высечено в камне: GitHub позволяет добавить, переименовать или удалить поле и представление в любой момент, не теряя уже собранные данные. Ошибка новичка — не «выбрать неправильное поле», а решить всё сразу и никогда не пересматривать.

Официальная документация
Best practices for Projects
Перевод и учебная адаптация официальной документации GitHub. Исходный материал — CC BY 4.0.

Коротко

  • Перед созданием Project стоит решить его область действия — один репозиторий или несколько.
  • Меньше полей и представлений, каждое из которых реально используется, лучше десятка «на будущее».
  • Status — встроенное поле; собственные поля стоит добавлять только когда Status не отвечает на нужный вопрос.