Skip to content

docs: 1.0.0から守る互換性の範囲と、ルールを廃止する手順を決める(#79) - #86

Merged
knk1313 merged 1 commit into
mainfrom
docs/79-compat-policy
Nov 3, 2026
Merged

knk1313 merged 1 commit into
mainfrom
docs/79-compat-policy

Conversation

@knk1313

@knk1313 knk1313 commented Nov 3, 2026

Copy link
Copy Markdown
Owner

🙋 誰が出すか(Author)

  • 書いた人:AIエージェント(管理者の依頼で書いた)
  • AIが書いた場合のモデルとハーネス:Claude Opus 5.5、Claude Code 2.1.312
  • 依頼した人の指示:
  • diffを確認した人:

✍️ 人が書く要約(Human-authored summary)

👏 解決する issue / Resolved Issues

📝 関連する issue / Related Issues

⛏ 変更内容 / Details of Changes

1.0.0から守る互換性の範囲を、README.mdの「バージョン管理」に書いた。範囲は、依頼した人が選んだ三つである。

範囲 壊さないもの マイナーの版でしてよい変更
ルール ルールIDと、その意味 ルールの追加、例と注記の追加、判定の直し
採点(score.mjs) 引数、終了コード、出力のJSONの項目名と型 出力への項目の追加
文書種別 識別名と、必須セクションの見出し 種別の追加、任意のセクションの追加
  • 同じ文書で出る指摘の数は、範囲に含めない。含めると、判定を直すたびにメジャーの版になるため
  • メジャーの変更の例に、「採点の出力の項目の削除や型の変更」を足した

ルールの廃止の手順を決めた。

  • rules/README.mdにあった「廃止(理由)」の1行の決まりに、置き換え先を足した。置き換え先があるときはIDを書く(「廃止(GRM-021に統合した)」)
  • 廃止はメジャーの変更とし、README.mdから参照した
  • Issueの本文には「廃止の手順が決まっていない」と書いたが、誤りだった。もとの決まりを広げる形にした

テストを足した。

  • tests/score.test.mjs:出力のJSONが、互換性を守る項目名と型を持つことを確かめる。項目を足すのはマイナーの変更でよいため、決めた項目があることと型だけを見る
  • tests/rules.test.mjs:廃止したルールの本文が「廃止(…)」の形であることを確かめる

🔎 既存のPR / Existing PRs

  • openとclosedの両方で、同じ問題を扱うPRを探した
  • 関連するPR:なし

🔍 確認したこと / Verification

  • 変更した日本語をskills/docs-rules/rules/のルールに照らして点検した(node --test tests/*.test.mjsの採点のテストを含め、65件が通った)
  • ファイルやディレクトリを増減した場合、README.mdのディレクトリ構成を更新した(増減はない)
  • .claude-plugin/やスキルの置き場所を変えた場合、CONTRIBUTING.mdの「プラグイン配布の検証」を通した(claude plugin validate .が通った)
  • python3 tests/test_skill_size.pyを通した
  • 関係のない変更を混ぜていない

🤖 Generated with Claude Code

- README.mdのバージョン管理に、互換性を守る範囲(ルールIDと意味、score.mjsの入出力、文書種別と必須セクション)を書いた
- ルールの廃止は「廃止(理由と置き換え先)」の1行にする
- 出力のJSONの項目名と型、廃止の書き方をテストで確かめる

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@knk1313
knk1313 merged commit 974b335 into main Nov 3, 2026
2 checks passed
@github-actions

github-actions Bot commented Nov 3, 2026

Copy link
Copy Markdown

Thank you for your contribution! 🎉

Spinning cat

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: 1.0.0から守る互換性の範囲と、ルールを廃止する手順を決める

1 participant