Skip to main content

audit-commits

Audit commits for issues and CHANGELOG entries

跳到安装

来源信息

仓库
gitkraken/vscode-gitlens
最近来源活动
2026年9月3日 20:38
检测到的 SKILL.md 语言
英语
星标
9,928
分支
1,801

安装方式

默认使用会先检查来源的 Prompt;你也可以切换为直接命令,或下载本地副本。

检查来源文件

决定是否安装前,请先阅读 SKILL.md,以及 SkillsMP 当前展示的配套文件。

正在显示 SKILL.md

SKILL.md
来源说明 · 只读预览
name
audit-commits
description
Audit commits for issues and CHANGELOG entries
# /audit-commits - Audit Commits Compare HEAD against a tag, identify user-facing commits, ensure they have linked issues and CHANGELOG entries. ## Usage ``` /audit-commits [tag] ``` No tag: suggest the most recent (`git tag --sort=-creatordate | head -10`). ## Workflow 1. **Fetch commits**: `git log --format="%h %s" <tag>..HEAD` 2. **Analyze each** (oldest first): - Get diff: `git show <sha> --stat` and `git show <sha>` - Classify: bugfix / feature / refactor / docs / tests / chore - Assess impact: High / Medium / Low / None - Check for linked issue (`#<num>` in message) 3. **Group related commits** (e.g., feature + immediate follow-up fix) 4. **Check each user-facing commit** against `[Unreleased]` in CHANGELOG.md 5. **Present summary**, confirm before creating issues or editing CHANGELOG ## CHANGELOG Management Uses [Keep a Changelog](http://keepachangelog.com/) format under `[Unreleased]`. ### Section Mapping | Change Type | Section | | ----------- | ---------- | | Feature | Added | | Enhancement | Changed | | Performance | Changed | | Bugfix | Fixed | | Deprecation | Deprecated | | Removal | Removed | ### Entry Format ```markdown - [Verb] [description] ([#issue](url)) ``` **Guidelines:** - Start with: "Adds", "Improves", "Changes", "Fixes", "Removes" - Use underscores for UI elements: `_Commit Graph_`, `_Home_ view` - Include issue reference if available - Be user-centric (what user sees, not code changes) **Example:** ```markdown - Fixes an issue where the _Home_ view would not update when switching repositories ([#4717](https://github.com/gitkraken/vscode-gitlens/issues/4717)) ``` ### Detection Check `[Unreleased]` section for: - Issue number reference (if commit has linked issue) - Keywords from commit message - Feature/component names ## Impact Assessment | Impact | Criteria | | ------ | -------------------------------------------------- | | High | New feature, breaking change, significant bugfix | | Medium | Enhancement, minor bugfix, performance improvement | | Low | Edge case fix, minor polish | | None | Refactor, internal cleanup, tests, docs-only | User-facing (High/Medium/Low) require issue + CHANGELOG. None = skip. ## Issue Creation Same workflow as `/create-issue`: duplicate detection, user confirmation, no auto-creation. After creating: `gh issue comment <num> --body "Closed by <commit_sha>"` ## Progress Display ``` Auditing commits: <tag>..HEAD Summary: - Total commits: 25 - User-facing: 12 (missing issue: 3, missing CHANGELOG: 5) - Not user-facing: 13 (skipped) ``` Then ask: "Process these commits? (create issues / update CHANGELOG / both / skip)" ## Safety 1. Describe behavior, not implementation — issues are public and their readers are users, so no code snippets, diffs, or internal details 2. NEVER create labels without user confirmation 3. **NEVER auto-create issues or edit CHANGELOG without user confirmation**
在 GitHub 查看