Генератор описания PR
Описание промпта
Инструмент для автоматического создания структурированного описания Pull Request на основе git diff и сообщений коммитов. Помогает разработчикам быстро документировать изменения, выделять критические моменты и обеспечивать контекст для ревьюеров.
- Автоматически генерирует структурированное описание Pull Request на основе кода и метаданных, экономя время разработчиков и улучшая качество ревью.
- Стандартизирует документацию, выделяет критические изменения, упрощает онбординг ревьюеров и служит живой документацией кодовой базы.
- Разработчики, DevOps-инженеры, технические лидеры, использующие Git и системы контроля версий.
Вставьте код в переменные {{GIT_DIFF}}, {{COMMIT_MESSAGES}} и {{CONTEXT}}. Укажите {{TICKET_ID}} и {{PR_TYPE}}. AI сгенерирует готовый Markdown.
Доступ к git diff, сообщениям коммитов и контексту задачи. Понимание структуры Markdown.
Готовый к копированию Markdown-блок, содержащий summary, список изменений, чек-листы и заметки по тестированию/деплою.
Регулярно обновляйте описание PR по мере получения обратной связи. Используйте для сложных рефакторингов и миграций зависимостей.
Не заменяет ручное ревью. Может упустить нюансы, если контекст в diff недостаточен. Требует точного ввода метаданных.
GIT_DIFF
GIT_DIFF
Содержимое git diff для анализа изменений.
COMMIT_MESSAGES
COMMIT_MESSAGES
Сообщения коммитов, связанные с PR.
CONTEXT
CONTEXT
Дополнительный контекст задачи или обсуждения.
TICKET_ID
TICKET_ID
Номер задачи или тикета (например, JIRA-123).
PR_TYPE
PR_TYPE
Тип изменения: feature, bugfix, refactor, docs, chore.
Промпт открыт для всех. Зарегистрируйтесь, чтобы копировать одним кликом, сохранять промпты, оценивать их и подписываться на авторов.
Текст промпта
ChatGPT / Claude / Llama
Войти для копирования
Выступи в роли опытного технического писателя с 10+ годами стажа. Твоя задача — проанализировать предоставленный git diff и/или сообщения коммитов, чтобы создать исчерпывающее описание Pull Request.
Ты должен извлечь суть изменений, объясняя не только «что» изменилось, но и «почему». Фокусируйся на контексте, который поможет ревьюерам быстрее понять изменения, сократить время на проверку и использовать описание как документацию.
Входные данные:
1. Git Diff: {{GIT_DIFF}}
2. Сообщения коммитов: {{COMMIT_MESSAGES}}
3. Дополнительный контекст: {{CONTEXT}}
4. Тикет/Задача: {{TICKET_ID}}
5. Тип PR: {{PR_TYPE}} (feature/bugfix/refactor/docs/chore)
Создай описание в следующем формате Markdown:
## Summary
[1-2 предложения: высокоуровневое описание того, что делает PR и зачем]
## Changes
- [Список конкретных изменений]
- [Группируй связанные изменения вместе]
- [Используй подпункты для деталей]
## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Breaking change
- [ ] Refactoring
- [ ] Documentation update
- [ ] Configuration change
- [ ] Dependencies update
## Testing
- [ ] Unit tests added/updated
- [ ] Integration tests added/updated
- [ ] Manual testing performed
### Test Instructions
[Как протестировать изменения вручную]
## Screenshots (if applicable)
[Скриншоты для UI изменений]
## Checklist
- [ ] Code follows project style guidelines
- [ ] Self-review completed
- [ ] Comments added for complex logic
- [ ] Documentation updated
- [ ] No new warnings introduced
## Related Issues
- Closes #[issue_number]
- Related to #[issue_number]
## Additional Notes
[Контекст для ревьюеров: компромиссы, будущая работа, заметки по деплою]
Ограничения:
- Извлекай «почему» из изменений, а не только «что».
- Группируй логически связанные изменения.
- Явно выделяй breaking changes.
- Включай шаги миграции, если они нужны.
- Отмечай изменения конфигурации и зависимости.
- Указывай влияние на производительность и безопасность.
- Держи summary кратким, но информативным.
Не делай:
- Не перечисляй каждую измененную строку.
- Не включай очевидные детали реализации.
- Не пиши размытые формулировки (например, «fixed stuff»).
- Не пропускай breaking changes или изменения API.
- Не забывай про инструкции по тестированию для нетривиальных изменений.Поделитесь в социальных сетях
Комментарии
Войдите, чтобы комментировать.
Комментариев пока нет.