changelog
Автоматическое ведение журнала изменений проекта
Ведение журнала изменений требует времени и подвержено ошибкам. Этот навык автоматизирует процесс, анализируя коммиты, PR и релизы для создания точных записей в журнале изменений, ориентированных на пользователей, в формате IdeaVim.
Скачать ZIP навыка
Загрузить в Claude
Перейдите в Settings → Capabilities → Skills → Upload skill
Включите и начните использовать
Протестировать
Использование «changelog». Update changelog for commits since last release
Ожидаемый результат:
- ## 2.29.0, 2024-01-15
- ### Features:
- * Added support for `g;` and `g,` commands to navigate through change list
- * Implemented `:history` command to show command history
- ### Fixes:
- * [VIM-3456] Fixed visual block mode with wrapped lines
- * [VIM-3458] Fixed `ci"` in strings with escaped quotes
- ### Merged PRs:
- * [850] by contributor: Add surround plugin improvements
Использование «changelog». Convert changelog to HTML for marketplace
Ожидаемый результат:
- <b>Features:</b><br>
- * Added support for <code>g;</code> and <code>g,</code> commands<br>
- * <a href="https://youtrack.jetbrains.com/issue/VIM-3456">VIM-3456</a> Fixed visual block mode<br>
Аудит безопасности
БезопасноThis is a pure documentation skill containing only markdown instructions. It provides guidelines for maintaining the IdeaVim changelog and contains NO executable code, network calls, or file operations. All 110 static findings are false positives from the analyzer misinterpreting markdown code block syntax as shell commands and documentation URLs as network indicators.
Факторы риска
⚙️ Внешние команды (59)
🌐 Доступ к сети (21)
📁 Доступ к файловой системе (1)
Оценка качества
Что вы можете построить
Автоматизация документации релизов
Поддерживайте журнал изменений проекта в актуальном состоянии с минимальными усилиями, автоматически анализируя коммиты и PR на предмет изменений, видимых пользователям.
Стандартизация заметок о релизах
Обеспечьте единообразную, профессиональную документацию релизов, которая следует установленным шаблонам и включает правильные ссылки на задачи и PR.
Документирование вклада сообщества
Правильно признавайте вклад внешних участников, автоматически включая их PR в журнал изменений, даже для внутренних изменений.
Попробуйте эти промпты
Обновите журнал изменений IdeaVim для предстоящего релиза 2.29.0. Проверьте коммиты с последней задокументированной версии и включите все изменения, видимые пользователям.
Обновите раздел [To Be Released] последними коммитами из ветки master. Сосредоточьтесь на видимых пользователям функциях и исправлениях ошибок.
Проверьте PR #1234 и определите, нужна ли для него запись в журнале изменений. Если да, подготовьте соответствующую запись в соответствии с форматом журнала.
Преобразуйте последние записи журнала изменений из раздела [To Be Released] в формат HTML для раздела changeNotes в build.gradle.kts.
Лучшие практики
- Всегда проверяйте сгенерированные записи журнала изменений на точность и понятность перед коммитом
- Включайте конкретные примеры команд или функций при описании исправлений или нового функционала
- Ссылайтесь на соответствующую документацию или блог JetBrains для новых интеграций с IntelliJ
Избегать
- Не включайте внутренний рефакторинг или очистку кода, которые не затрагивают пользователей
- Избегайте расплывчатых описаний типа "Исправлены ошибки" без указания того, что было исправлено
- Никогда не пропускайте этап ручной проверки — автоматизированный журнал изменений всё равно требует проверки человеком