おさむのひと 2328ef3737

chore(llm/docs): .claude配下の再構成 (#17514 )

* chore(docs): .claude配下の再構成

* fix AGENTS.md

* fix AGENTS.md

* fix review

* 行番号参照の除去

* docs: fix storybook note in vue reviewer agent

* Potential fix for pull request finding

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

* Potential fix for pull request finding

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

* Potential fix for pull request finding

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

* fix local review

* fix

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

2026-06-03 09:03:10 +09:00

3.4 KiB

Raw Permalink Blame History

CHANGELOG.md の Unreleased セクションに 1 行追記する

ユーザー影響のある変更 (機能追加・修正・改善) は CHANGELOG.md の冒頭 ## Unreleased セクションに 1 行追加する。リファクタリング等の内部変更は不要。

セクション構造

## Unreleased 配下に 3 つのサブセクション が用意されている:

### General — 共通 / 横断的な変更
### Client — packages/frontend 系
### Server — packages/backend 系

エントリ書式

該当サブセクションに - <Prefix>: <概要> の形式で追加。Prefix は先頭大文字。

- Enhance: ノートの詳細表示での公開範囲の表示を改善
- Fix: 通知が約10秒遅延する問題を修正
- Feat: 新機能の追加

Prefix	用途
`Feat:`	新機能の追加
`Enhance:`	既存機能の改善
`Fix:`	バグ修正
`Note:`	機能変更ではないが利用者に知らせたい事項 (設定の初期化・config 項目の追加・非互換な挙動変更など)

Note: は Feat / Enhance / Fix のような変更そのものではなく、「アップデート後に利用者が知っておくべき注意」を伝えるためのもの (例: - Note: アップデート後、サウンドに関する設定が初期化されます)。該当サブセクション内に - Note: ... として置く。リリースによっては ## <version> 直下に ### Note 専用サブセクションを設ける形もある (既存履歴に両パターンあり)。新規追加時は近傍の既存エントリの書き方に合わせる。

触ってはいけない範囲

## Unreleased 以外のセクション (過去リリース) は変更しない
## Unreleased の見出しと 3 つの空サブセクション骨格自体は維持する (リリーススクリプトが期待する構造)

作業手順 (手で書く場合)

CHANGELOG.md を開いて ## Unreleased セクションを探す
対象サブセクション (### General / ### Client / ### Server) の状態を確認
- 空 (placeholder のみ): 見出し直下に - 単独行のみがある → これを - Feat: ... 等で置換
- 既存エントリあり: - Enhance: ... / - Fix: ... 等の行が 1 つ以上ある → 既存エントリ群の末尾に追記
順序入れ替えはしない (差分レビューしやすさのため)
git diff CHANGELOG.md で 1 行のみ追加されていることを確認

例

引数イメージ	結果
server, `Fix: 通知が遅延する問題を修正`	`### Server` 末尾に `- Fix: 通知が遅延する問題を修正` を追記
client, `Enhance: ノートの表示を改善`	`### Client` 末尾に `- Enhance: ノートの表示を改善` を追記
general, `Feat: 新機能の追加`	`### General` の placeholder `-` を `- Feat: 新機能の追加` で置換

コミットメッセージ書式との違い

CHANGELOG とコミットメッセージは 書式が異なる:

CHANGELOG: - Enhance: ノートの表示を改善 (先頭大文字の英語 Prefix + コロン + 日本語本文)
コミットメッセージ: enhance(frontend): improve note display (小文字 + スコープ + コロン + 英語本文。詳細は CONTRIBUTING.md)

両方を 1 つの PR で更新するときに混同しないこと。

3.4 KiB Raw Permalink Blame History