audit-commits

Audit Git commits between a tag and HEAD for issues and CHANGELOG entries.

9.9k|1.8k|Updated Aug 8, 2016
One-click install
npx skills add https://github.com/gitkraken/vscode-gitlens --skill audit-commits
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: audit-commits
Source: https://github.com/gitkraken/vscode-gitlens/tree/main/.claude/skills/audit-commits
Command: npx skills add https://github.com/gitkraken/vscode-gitlens --skill audit-commits

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the process of auditing Git commits to ensure user-facing changes are properly documented with linked issues and CHANGELOG entries.

Core Features & Use Cases

  • Commit Analysis: Compares HEAD against a specified tag to identify new commits.
  • Issue & CHANGELOG Verification: Checks if user-facing commits have corresponding issue numbers and entries in the CHANGELOG.md file.
  • Use Case: Before releasing a new version, use this Skill to automatically verify that all new features and bug fixes have been correctly documented and linked to their respective tickets.

Quick Start

Run the audit-commits skill to audit commits since the last release tag.

Frequently Asked Questions about audit-commits

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check if my Git commits have corresponding issue numbers before a release?

You can audit commits between a specified tag and HEAD to verify linked issues, identify user-facing changes, and ensure all new features and bug fixes have corresponding issue numbers before releasing a new version.

How do I verify that my CHANGELOG entries match my recent Git commits?

Verifying CHANGELOG entries against recent Git commits involves auditing changes between a release tag and HEAD to ensure user-facing commits have matching entries in the CHANGELOG.md file and are properly linked to their respective tickets.

What is the best way to audit commits for user-facing changes before publishing a release?

Auditing commits for user-facing changes involves comparing HEAD against a specified release tag to classify commits by impact, group related changes, and verify that linked issues and CHANGELOG entries are present.

Does the commit auditing process require any specific dependencies or external tools?

The commit auditing process does not require any external dependencies or tools, allowing you to directly analyze Git commits, verify issue tracking links, and check CHANGELOG.md entries without additional environment setup.

When do I need to audit commits for issue tracking and CHANGELOG verification?

You need to audit commits for issue tracking and CHANGELOG verification when preparing a new version release, ensuring that all user-facing changes made since the last release tag are correctly documented and linked to their respective tickets.