AgentSkillsCN

changelog-fragment

为代码变更生成变更日志片段文件。在完成功能开发、漏洞修复或其他面向用户的变化后，若需为这些改动添加对应的变更日志条目，可使用此功能。

SKILL.md
--- frontmatter
name: changelog-fragment
description: >
  Generate a changelog fragment file for code changes. Use this after implementing
  features, bug fixes, or other user-facing changes that need changelog entries.
allowed-tools: Write, Bash, Read, Glob, Grep

Generate Changelog Fragment

Create a changelog fragment file documenting the current changes.

Instructions

  1. •Determine what changed by reviewing recent git diffs or the work done in this session
  2. •Choose the kind:
    • •feature — new functionality
    • •bugfix — bug fix
    • •enhancement — improvement to existing functionality
    • •deprecation — deprecated functionality
    • •breaking — breaking change
  3. •Write a concise description — one clear sentence explaining what changed and why
  4. •Determine which extension(s) are affected by looking at which files changed:
    • •Changes in vscode/core/, webview-ui/, shared/, agentic/ → core
    • •Changes in vscode/java/ → java
    • •Changes in vscode/javascript/ → javascript
    • •Changes in vscode/go/ → go
    • •Changes in vscode/csharp/ → csharp
    • •Changes in vscode/konveyor/ → konveyor
    • •If the change only affects core, omit the extensions field (it defaults to core)
    • •If the change affects non-core extensions, or multiple extensions, include extensions
  5. •Name the file changes/unreleased/<pr-number>-<short-description>.yaml
    • •If the PR number is not known, use a descriptive name like add-dark-mode.yaml
  6. •Write the fragment using this format:
yaml
kind: <kind>
description: >
  <description>.

Or with explicit extension targeting:

yaml
kind: <kind>
description: >
  <description>.
extensions:
  - java

Rules

  • •Ignore test-only changes: If the changes are exclusively in the tests/ folder (e.g. adding or updating E2E tests), do not create a changelog fragment — these are not user-facing changes
  • •Description must be a single sentence, ending with a period
  • •Use active voice: "Fixed X" not "X was fixed", "Added Y" not "Y has been added"
  • •Be specific: "Fixed crash when analyzer encounters empty rulesets" not "Fixed a bug"
  • •Do not include PR numbers in the description (they are derived from the filename)
  • •Valid extensions: core, java, javascript, go, csharp, konveyor
  • •Omit extensions for core-only changes (it defaults to core)

Examples

For a core bug fix PR #1234:

File: changes/unreleased/1234-fix-sso-auth.yaml

yaml
kind: bugfix
description: >
  Fixed authentication flow when using SSO providers with custom certificates.

For a Java extension feature PR #1235:

File: changes/unreleased/1235-add-java-provider.yaml

yaml
kind: feature
description: >
  Added support for custom Java external provider configuration.
extensions:
  - java

For a change affecting multiple extensions:

File: changes/unreleased/1236-shared-api-update.yaml

yaml
kind: enhancement
description: >
  Updated provider registration API for improved language extension compatibility.
extensions:
  - core
  - java
  - go

Validation

After creating the fragment, validate it:

bash
node scripts/changelog.js validate