Как и многие из вас (я надеюсь), я склонен засорять свой код и статьи символами TODOs, находясь в процессе написания кода или написания. Я намерен вернуться к ним и действовать в какой-то момент, но, как и многие благие намерения, и особенно задачи, найти их снова — это одна из проблем.
Мне нравится иметь задачи, назначенные мне в средствах отслеживания проблем, чтобы мне было легче их находить, и добавление задач в середине кода или документов (я смотрю на вас, Документы Google!) Не выдает их на мой взгляд.
Несколько месяцев назад я наткнулся на замечательное приложение GitHub todo от Jason Etco , которое он создал с помощью Probot . Приложение анализирует ваш код для TODOs или других ключевых слов и добавляет их как проблемы GitHub с предварительно сконфигурированными сотрудниками, метками и многим другим.
Вам также может понравиться:
Что такое DevOps? Руководство для начинающих
Установить и настроить
Установите приложение в своем репо, посетив страницу приложения и нажав кнопку « Настроить» . Из-за разрешений GitHub вы, возможно, не сможете установить приложение во всех репозиториях, которые вам нужны, или вам может потребоваться запросить разрешение у администратора организации. Если у вас есть правильные разрешения, вы можете установить приложение во всех своих репозиториях или определенных репозиториях.
Приложение todo имеет разумные значения по умолчанию , назначая задачу коммиттеру, поэтому оно работает сразу после его установки, но вы, вероятно, захотите погрузиться в настройку отдельных репозиториев, особенно тех, над которыми вы сотрудничаете с другими.
Прежде чем мы добавим какой-либо код и создадим проблемы, давайте изменим несколько настроек.
Как и в случае с другими приложениями GitHub, вам необходимо создать папку .github на верхнем уровне вашего репозитория, а внутри — файл config.yml . Вот настройки, которые вы можете изменить, и все они являются дочерними ключами todoклавиши:
todo:
keyword: ["@todo", "TODO", "TODO:"]
autoAssign: true
bodyKeyword: ["@body", "BODY"]
blobLines: 10
caseSensitive: false
label: ["todo", "bot"]
reopenClosed: true
Большинство настроек достаточно понятны, но вы можете найти полную ссылку в проекте, прочитайте меня .
Приведенные выше настройки позволяют приложению todo выполнять следующие действия:
- Ищите три ключевых слова в своем коде
- Автоматически назначать проблемы тому, кто выдвинул изменение; вместо этого вы можете добавить массив имен пользователей вручную
- Добавьте любой текст в тело вопроса, равный значению (ям)
bodyKeywordв вашем коде - Включает десять следующих строк кода в тело вопроса
- Добавляет две метки
- Повторно открывает все соответствующие проблемы уже закрыты
Продвиньте свою производительность
Вы можете увидеть задачи в моем коде на этой странице поиска , и для запуска бота вам нужно перейти в любую ветку. Если вы нажмете на ветку, в которой уже есть PR, приложение добавит его в качестве комментария вместо новой проблемы. Полезно, что приложение также пытается закрыть проблемы, как только соответствующий текст будет удален как часть пиара.
И вуаля! Проблемы автоматически создаются каждый раз, когда вы добавляете их. Теперь все, что вам нужно сделать дальше, это на самом деле работать над проблемами, но это совсем другая история.
Дальнейшее чтение
9 функций, которые делают отличный инструмент управления задачами