tickgit — это инструмент командной строки и
tickgit сканирует исходный код на наличие маркеров TODO (а также HACK, FIXME, XXX и т. д.) и представляет эти комментарии к коду в виде билетов с более полным контекстом, полученным из истории Git (кто добавил, когда, где и т. д.).
Я разработчик- одиночка, создаю tickgit и tickgit.com, чтобы помочь разработчикам программного обеспечения быть более продуктивными в своем коде. Надеюсь, вы найдете этот проект интересным и полезным!
интерфейс тикгит
Эта статья является частью дорожной карты, где мы рассматриваем создание и продвижение продуктов с точки зрения разработчика. Мы поделимся лучшими уроками от лидеров продуктов и предоставим техническим основателям возможность поделиться с вами своими продуктами на ранней стадии. Если вы заинтересованы в том, чтобы быть представленными, дайте нам знать.
Почему?
Управление проектами — неотъемлемая часть разработки программного обеспечения, даже для
Почему // Комментарии TODO?
Комментарии TODO (или FIXME, HACK, OPTIMIZE, XXX и т. д.) — это распространенный способ, с помощью которого разработчики указывают, что область кода стоит рассмотреть и вернуться к ней. Кодовая база Linux насчитывает более 4 тыс. таких комментариев, в Kubernetes — более 2 тыс.
Если подобные вещи вам знакомы, вы, несомненно, видели или использовали их раньше:
// TODO: Get rid of this condition somehow. Perhaps with a dynamic version
// of the @gate pragma.
TODO — это просто
Задачи легко добавлять и удалять. Вам не нужно покидать редактор. Они открытого текста. Вы можете включить ссылки на дополнительную информацию. Они гибкие. Вы даже можете использовать смайлики 😀✏️. Вы не ограничены полевыми требованиями внешней системы продажи билетов. Вы можете быть как можно полнее или лаконичнее, описывая, почему вы аннотируете область кода.
Нет переключения контекста
Задачи находятся прямо рядом с кодом, который они описывают, что означает, что вы не теряете контекст кодовой базы: окружающие классы, функции, переменные и т. д. Использование внешней системы тикетов требует, чтобы вы либо переключали фокус при попытке чтобы понять тикет и соответствующие фрагменты кода, или сделать много копирования контекста, чтобы помочь прояснить вашу задачу.
Списки задач позволяют вам поддерживать поток при написании кода и часто требуют меньше умственной нагрузки, чем переключение между заявками во внешней системе и обратно. Конечно, задачи могут ссылаться на существующий тикет для получения дополнительной информации, если это необходимо.
Отслеживается с помощью вашего кода
Поскольку комментарии TODO являются частью вашего кода, они хранятся в системе контроля версий. Они могут пройти
Инструмент командной строки
Инструмент командной строки tickgit — это проект с открытым исходным кодом, который сканирует кодовую базу Git на наличие комментариев TODO. Он запускает проверку Git и выводит результаты со ссылками на пути к файлам и номера строк.
Его можно использовать для специального запроса открытых комментариев TODO и поддерживает вывод CSV для использования другими инструментами (электронными таблицами, текстовыми процессорами и т. д.).
Вот пример вывода:
пример вывода
Интерфейс командной строки в настоящее время довольно прост, но мы планируем улучшить его, чтобы включить больше вариантов использования, в том числе:
Настройка фраз для соответствия (не совпадать с XXX, но совпадать @TODOв комментариях)
Запросы и фильтрация (показать все задачи, добавленные на этой неделе, показать только мои и т. д.)
Совокупные запросы подсчитываются по авторам, среднему возрасту по авторам и т. д.
Режим CI завершается сбоем с ошибкой, если выполняются определенные критерии (нет задач в определенных ветках, максимум 5 задач на автора и т. д.)
Извлечение ссылок и индивидуальный анализ комментариев (извлечение исполнителя, срок выполнения и т. д.)
tickgit.com
Веб -приложение tickgit — это SaaS, которое в настоящее время интегрируется с GitHub. Это бесплатно (регистрация не требуется) для использования в общедоступных репозиториях. Вы можете просмотреть открытые комментарии TODO и некоторую сводную статистику, включая диаграммы количества по авторам и средний возраст по авторам.
Каждый комментарий TODO представлен в виде карты, которая показывает ту же информацию, что и CLI. Щелкнув мышью, вы перейдете к файлу и строке комментария TODO в пользовательском интерфейсе GitHub.
Файл TODO и строка под страницей
Частные репозитории поддерживаются за 3 доллара США в месяц (для частных лиц). Все функции бесплатной версии (для общедоступных репозиториев) есть в платной версии для частных репозиториев.
Некоторые улучшения, которые находятся на пути, включают:
Подпишитесь на комментарии TODO репозитория в виде еженедельной сводки по электронной почте.
Улучшенные запросы и фильтрация (найти мои задачи, задачи старше даты и т. д.)
Поддержка большего количества хостов Git (GitLab, BitBucket, sourcehut и т. д.)
Улучшенная интеграция со сторонними инструментами, такими как Trello, Jira и Slack.
Перейдите на сайт tickgit.com и попробуйте один из ваших общедоступных репозиториев. Я надеюсь, вы будете удивлены тем, насколько эффективнее вы сможете справиться с невыполненной работой, о которой вы даже не подозревали!
