sparkle-design-cli 2.4.1 → 2.5.0-beta.1

package/CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# コントリビューション
+
+## セットアップ
+
+```bash
+# submodule（templates/sparkle-variables）を取得
+# ※ 未初期化だと generate とそれに依存するテストが失敗する
+git submodule update --init --recursive
+
+# 依存関係をインストール
+npm install
+
+# パッケージをローカルでリンク
+npm link
+```
+
+## 開発用コマンド
+
+```bash
+npm test                        # Node.js test runner
+npm run test:watch              # テストの watch 実行
+npm run lint                    # ESLint
+npm run lint:fix                # ESLint 自動修正
+npm run format                  # Prettier
+npm run format:check            # Prettier チェックのみ
+npm run sync:anti-pattern-docs  # ルールの解説を隣接リポジトリの JSDoc / スキルへ配る（README は対象外）
+```
+
+> **`sync:anti-pattern-docs` の注意:** ワークスペース内の隣接リポジトリ（`../sparkle-design` / `../sparkle-design-internal`）のファイルを書き換える横断スクリプトです。両リポジトリが隣にある Sparkle ワークスペース内で実行してください（worktree からは sibling が解決できず落ちます）。**このリポジトリの README は書き換えません** — ルール一覧は `rules` コマンドが出すためです。
+
+## リリース手順（メンテナ向け）
+
+publish は GitHub Actions の **Publish to npm** workflow 経由。ローカル `npm publish` は禁止。
+
+1. `package.json` の `version` を更新（安定版: `X.Y.Z` / RC: `X.Y.Z-rc.N` / Beta: `X.Y.Z-beta.N`）
+2. `CHANGELOG.md` に該当セクションを追加
+3. PR をマージ後、**Publish to npm** workflow を `channel: auto` で実行
+
+`channel: auto` は `package.json` の version 形式から dist-tag を自動判定します（`-beta.N` → `beta` / `-rc.N` → `next` / それ以外 → `latest`）。既存 RC / Beta を latest に昇格させる場合は、新しい `X.Y.Z` として改めて publish します（`npm dist-tag add` での手動付け替えも可能ですが、version 管理が明確になる前者を推奨）。
+
+## ドキュメントの構成
+
+| 置き場所          | 何を書くか                             |
+| ----------------- | -------------------------------------- |
+| `README.md`       | 導入して動かすまでに要る最低限だけ     |
+| `docs/`           | 個別機能の詳細・背景・トレードオフ     |
+| `CONTRIBUTING.md` | このリポジトリ自体を開発するときの手順 |
+
+**ルールの一覧をドキュメントに書き足さないでください。** `lib/anti-pattern-rules.js` が単一の正解で、利用者向けには `sparkle-design-cli rules` が出力します。過去に README / `check --help` / setup-guide / JSDoc / スキルの features.md と 6 箇所へ写しが散らばり、`check --help` は組み込み 18 件のうち 16 件しか載せず `check` のルールでない項目を 2 件含んだまま腐っていました。
+
+`scripts/sync-anti-pattern-docs.mjs` が配るのは、コンポーネントの JSDoc とスキルの `sparkle-design-features.md` だけです（どちらも一覧ではなくコンポーネント固有の解説）。