changelog-automation

変更履歴の自動化

業界標準に準拠した変更履歴の生成、リリースノート、バージョン管理を自動化するためのパターンとツールです。

このスキルを使用する場面

• 変更履歴の自動生成を設定するとき
• Conventional Commits を導入するとき
• リリースノートのワークフローを作成するとき
• コミットメッセージの形式を標準化するとき
• GitHub/GitLab のリリースノートを生成するとき
• セマンティックバージョニングを管理するとき

中核となる概念

1. Keep a Changelog 形式

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## Detailed patterns and worked examples

Detailed pattern documentation lives in `references/details.md`. Read that file when the navigation tier above is insufficient.

## Summary

This release introduces dark mode support and improves checkout performance
by 40%. It also includes important security updates.

## Highlights

### 🌙 Dark Mode

Users can now switch to dark mode from settings. The preference is
automatically saved and synced across devices.

### ⚡ Performance

- Checkout flow is 40% faster
- Reduced bundle size by 15%

## Breaking Changes

None in this release.

## Upgrade Guide

No special steps required. Standard deployment process applies.

## Known Issues

- Dark mode may flicker on initial load (fix scheduled for v2.1.1)

## Dependencies Updated

| Package | From    | To      | Reason                   |
| ------- | ------- | ------- | ------------------------ |
| react   | 18.2.0  | 18.3.0  | Performance improvements |
| lodash  | 4.17.20 | 4.17.21 | Security patch           |

コミットメッセージの例

# Feature with scope
feat(auth): add OAuth2 support for Google login

# Bug fix with issue reference
fix(checkout): resolve race condition in payment processing

Closes #123

# Breaking change
feat(api)!: change user endpoint response format

BREAKING CHANGE: The user endpoint now returns `userId` instead of `id`.
Migration guide: Update all API consumers to use the new field name.

# Multiple paragraphs
fix(database): handle connection timeouts gracefully

Previously, connection timeouts would cause the entire request to fail
without retry. This change implements exponential backoff with up to
3 retries before failing.

The timeout threshold has been increased from 5s to 10s based on p99
latency analysis.

Fixes #456
Reviewed-by: @alice

ベストプラクティス

推奨事項

• Conventional Commits に従う - 自動化が可能になります
• 明確なメッセージを書く - 将来の自分が感謝します
• issue を参照する - コミットをチケットにリンクします
• スコープを一貫して使用する - チームの規約を定義します
• リリースを自動化する - 手作業によるミスを減らします

非推奨事項

• 変更を混在させない - 1 コミットにつき 1 つの論理的な変更にします
• 検証を省略しない - commitlint を使用します
• 手動で編集しない - 生成された変更履歴のみを使用します
• 破壊的変更を忘れない - ! またはフッターでマークします
• CI を無視しない - パイプラインでコミットを検証します