verifying-changelog-in-framework
Rules for Verifying CHANGELOG.md in Framework
- フレームワークを利用するユーザー視点で、パッケージに変更が生じる場合は必ず CHANGELOG.md を更新します
- 基本的に src/ 以下の private でないクラスやメソッドに変更があった場合は更新が必要です
- この際、実装が破壊的変更(breaking change)を伴う場合は、SemVer における minor バージョンまたは major バージョンの更新で対応する必要があることに注意します
- ただし、内部の不具合を修正するために生じる変更(バグフィックス)は影響度の小さい破壊的変更であれば patch バージョンの更新を許容します
Important Formatting and Content Rules
変更に CHANGELOG.md を更新する際は、以下のフォーマットに従ってください。
- フォーマットは Keep a Changelog に基づく
- CHANGELOGは全てユーザー目線で見える変更を記述する
- 実装した詳細を書くのではなく、そのサービスを利用する人(ユーザー)から見たときにどのような機能追加・変更・修正があったのかを端的に記載する
- ユーザーから本フレームワークを見たときのいわゆるインターフェイスとなる外側部分についてどんな変化が起きたかを書くこと
- 本フレームワークにどんな変化があったかではなく、ユーザーが使うときにどんな影響があるかを書くこと
- PR や Issue の番号は
[#123](github.com/your-repo/issues/123)のようにリンク形式で記載する - システムやコード、クラスを主語にする
- 変更点や追加内容等は端的に記載する
- バグ修正の場合はどのような事象・問題が起きていたかを記載する
- 代替手段がある場合は記載する
- クラス名は多少冗長でもFQCNで書く
More from seika139/dotfiles
creative-frontend-aesthetics
AI特有の「ありきたりなデザイン(AI slop)」を回避し、独創的で洗練されたUIを構築する。LP、ダッシュボード、アプリのフロントエンド実装時に適用。
116high-end-typography
汎用的なフォントを避け、デザイン性の高いタイポグラフィを選択してフロントエンドの質を向上させるスキル。UI制作やLP作成時に使用します。
28checking-breaking-changes-in-php-framework
外部公開を想定したphpフレームワークのコードレビューをする際に、破壊的変更(breaking change)の有無を確認し、破壊的変更がある場合は適切に処理されているかをチェックするスキルです。
23with-codex
Enables Claude Code to collaborate with OpenAI Codex CLI on Windows. Use this skill when the user wants to get a second opinion from Codex, compare approaches between Claude and Codex, or leverage both AI assistants for collaborative problem-solving. This skill supports both non-interactive mode (automatic response retrieval) and interactive mode (visual pane splitting with tmux).
22gh-link-subissues
GitHub Issue に Sub-issue を紐付けます。クロスリポジトリ対応。親 Issue の URL/番号と、子 Issue の URL/番号リストを指定してください。
10gh-unlink-subissue
GitHub Issue から Sub-issue の紐付けを解除します。親 Issue の URL/番号と、解除する子 Issue の URL/番号を指定してください。
2