alexbruno/dev-skills

changelog-management

Maintain and update a standardized root CHANGELOG.md following Keep a Changelog and Semantic Versioning.

ソースを見る

使い方

  1. インストールコマンドをコピーし、自分の環境へ導入する前にソースを確認します。
  2. 必要なツール、認証情報、対応環境を原文で確認します。
  3. 入力と成果物を指定し、出力を資料と照合します。
npx skills add https://github.com/alexbruno/dev-skills --skill changelog-management

開始前の確認

  • 導入にはモデル契約、API枠、ファイルへのアクセス許可は含まれません。
  • スター数や導入数は活動の指標であり、独立した品質・安全性試験ではありません。
リポジトリの原文

見出し、例、コード、表、リンク、参照画像を含む原文を表示しています。

Changelog Management

Maintain a clean, human-readable record of notable changes at the repository root in CHANGELOG.md.

This skill enforces the widely adopted Keep a Changelog standard and aligns with Semantic Versioning (SemVer).


Core Principles

  1. Root Location: Always maintain the changelog in CHANGELOG.md at the project root. Initialize it from ./resources/CHANGELOG.md if it does not exist yet.
  2. Written for Humans: Changelogs are for people, not machines. Summarize user-facing, functional, or architectural impacts clearly; do not paste raw git commit logs.
  3. Always Track `[Unreleased]`: Ongoing contributions are accumulated in the ## [Unreleased] section at the top of the file before a release is cut.
  4. Standard Categories: Group entries strictly under standard category headings (omit empty categories in published releases):
  • ### Added — for new features and public capabilities.
  • ### Changed — for changes in existing functionality.
  • ### Deprecated — for features scheduled for removal in future releases.
  • ### Removed — for features now removed.
  • ### Fixed — for bug fixes.
  • ### Security — for vulnerability remediations or security enhancements.

Proactive Suggestion Triggers

The agent must proactively suggest updating CHANGELOG.md at opportunistic moments, rather than waiting for an explicit command:

When to Suggest

  • Feature or Bugfix Completion: After implementing or verifying a feature, bug fix, or behavioral change (e.g., when completing a vertical slice or signing off on workflow/SPEC.md / workflow/PLAN.md).
  • Breaking Changes or Deprecations: Immediately upon modifying a public API, configuration schema, database contract, or CLI flag.
  • Pre-Commit / Pre-PR / Code Review: During code review or before preparing a PR or commit that introduces notable changes.
  • Release Preparation: When the user mentions tagging, publishing, or releasing a new version.

Prompting Format

When a qualifying change occurs, offer a clear, ready-to-use proposal:

"I noticed we just implemented `<brief description of change>`. Would you like me to record this under `[Unreleased]` (`Added` / `Fixed` / `Changed`) in `CHANGELOG.md`?"

When NOT to Suggest (Avoid Noise)

Do not prompt the user or update CHANGELOG.md for:

  • Routine internal refactorings that preserve behavior and interfaces.
  • Typo corrections in internal comments or documentation.
  • Test-only adjustments, benchmark tweaks, or local development tool configs (unless they affect consumers or project contributors significantly).

Changelog Entry Guidelines

Each bullet under a category should follow these rules:

  • Imperative or descriptive summary: Begin with a capitalized verb or concise summary (e.g., - Add support for..., - Fix memory leak in..., - Deprecate legacy auth flag...).
  • Link issues / PRs / contributors (if applicable): Append issue or PR references (e.g., (#123)) when known.
  • Highlight breaking changes: Prefix breaking modifications explicitly with **BREAKING:** under ### Changed or ### Removed.

Release Bumping Workflow

When cutting a release (e.g., from Unreleased to v1.2.0):

  1. Determine SemVer Level:
  • MAJOR (X.0.0): One or more breaking changes.
  • MINOR (0.X.0): New backward-compatible features (Added).
  • PATCH (0.0.X): Backward-compatible bug fixes (Fixed).
  1. Transform `[Unreleased]`:
  • Create a new header below ## [Unreleased]: ## [X.Y.Z] - YYYY-MM-DD (using current date in ISO format).
  • Move all accumulated bullets from [Unreleased] into the new release section.
  • Leave ## [Unreleased] empty, ready for subsequent work.
  1. Compare Links (Optional):
  • If the repository uses GitHub/GitLab tag comparisons, update or append diff links at the bottom of CHANGELOG.md (e.g., [Unreleased]: https://github.com/org/repo/compare/v1.2.0...HEAD).
同じリポジトリから

関連する Skills

すべての Skills
alexbruno
コミュニティ

architect-worker

Role-based multi-agent software engineering pattern separating high-level architecture, specification, planning, and code review (Architect) from focused code implementation and verification (Worker). Use this skill whenever assigned the Architect or Worker role (in any language), or when coordinating work between planning/review agents and implementation agents via workflow/.

1時間の導入数
1
GitHub Stars
0
更新日
11月13日
alexbruno
コミュニティ

code-review

Perform structured, multi-dimensional code reviews aligned with the spec-driven-workflow (workflow/SPEC.md, workflow/PLAN.md, workflow/REVIEW.md). Use this skill after implementing a feature or bug fix, before merging a PR, or when reviewing changes written by another agent or human.

1時間の導入数
1
GitHub Stars
0
更新日
11月13日
alexbruno
コミュニティ

code-simplification

Simplify code for human readability, clarity, and directness without changing behavior. Use this skill after implementing a feature, during refactoring, or when addressing code review feedback—especially when code feels over-engineered, deeply nested, or takes unnecessary detours to do simple things.

1時間の導入数
1
GitHub Stars
0
更新日
11月13日
alexbruno
コミュニティ

codebase-indexing

Index, synchronize, and query a project's codebase using CodeGraph and Repomix. Use this skill when exploring an unfamiliar repository, maintaining up-to-date code intelligence after edits, or setting up project indexing with .codegraph/ and Markdown-formatted Repomix snapshots.

1時間の導入数
1
GitHub Stars
0
更新日
11月13日