Skip to content

Chore/doc org#2

Merged
mkXultra merged 2 commits intodevelopfrom
chore/doc_org
Jan 20, 2026
Merged

Chore/doc org#2
mkXultra merged 2 commits intodevelopfrom
chore/doc_org

Conversation

@mkXultra
Copy link
Owner

@mkXultra mkXultra commented Jan 20, 2026

Summary

  • ドキュメントの整理とシンプル化
  • 手動リリーススクリプトの削除(semantic-releaseに移行済み)

Changes

削除

  • scripts/ ディレクトリ(手動リリーススクリプト4ファイル)
  • assets/ ディレクトリ(スクリーンショット10ファイル)
  • docs/local_install.md

作成

  • CONTRIBUTING.md - 開発者向けガイド(セットアップ、テスト、環境変数など)

更新

  • README.md - 377行 → 78行にシンプル化
  • docs/RELEASE_CHECKLIST.md - タグの重要性について追記

Test plan

  • README.mdが正しく表示される
  • CONTRIBUTING.mdのリンクが機能する

Summary by CodeRabbit

リリースノート

  • Documentation

    • 開発者向けコントリビューションガイドラインを追加
    • READMEを簡潔にリニューアルし、セットアップ手順に焦点化
    • リリースプロセスの手順書を更新し、NPM公開フローを明確化
  • Chores

    • レガシースクリプトおよび設定復元機能を削除
    • ローカル開発ドキュメントを統合・削除

✏️ Tip: You can customize this high-level summary in your review settings.

@mkXultra mkXultra self-assigned this Jan 20, 2026
@coderabbitai
Copy link

coderabbitai bot commented Jan 20, 2026

Caution

Review failed

The pull request is closed.

Walkthrough

開発ドキュメント整備とリリースプロセスの簡素化を実施。新しい CONTRIBUTING.md を追加して開発ガイドを集約し、README.md を簡潔化。複数のリリース自動化スクリプトを削除し、docs/RELEASE_CHECKLIST.md で develop ブランチへの更新と OIDC ベースの公開手順に変更。

Changes

Cohort / File(s) 変更内容
ドキュメント追加
CONTRIBUTING.md
開発セットアップ、テストコマンド(全体/ユニット/e2e/ローカルe2e/監視/カバレッジ)、MCP Inspector による手動テスト、npm link での開発、環境変数、semantic-release と Conventional Commits を用いたリリースプロセス、ライセンス情報を新規追加。実行可能なコード変更なし。
ドキュメント削除
docs/local_install.md
ローカルインストール・開発ガイドを削除。リポジトリのクローン、依存関係インストール、MCP クライアント設定、CLAUDE CLI 権限、環境変数、ビルド、npm link、再ビルド手順を含むコンテンツを削除。
README 簡素化
README.md
概要・メリット・前提条件・設定・インストール・使用法・接続・ツール・例・トラブルシューティング・テスト・貢献ガイドを削除または縮約。最小限の JSON インストール例に変更。包括的なガイドから簡潔なリファレンスへ移行。
リリースプロセス更新
docs/RELEASE_CHECKLIST.md
マージ対象を main から develop に変更。「Manual Release」ヘッダを「Important: Git Tags」に置換。semantic-release の実行手順を段階的チェックリスト形式に変更。OIDC 信頼済み公開を使用(npm トークン不要)と記載。npmjs.com アカウントとリポジトリ設定情報を追加。
スクリプト削除
scripts/check-version-log.sh, scripts/publish-release.sh, scripts/restore-config.sh, scripts/test-release.sh
バージョンログ検査スクリプト(34 行)、リリース自動化スクリプト(95 行)、Claude 設定復元スクリプト(28 行)、ローカルリリース テストスクリプト(69 行)を削除。リリース関連のシェルスクリプト自動化を廃止。

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 ドキュメント整え、スクリプトさようなら
開発ガイド、CONTRIBUTING に集約
README は軽く、develop へシフト
自動化は手放して、シンプルに前へ
✨ 新しい流れ、整理完了!

✨ Finishing touches
  • 📝 Generate docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@mkXultra mkXultra merged commit dcdaf5a into develop Jan 20, 2026
3 of 4 checks passed
@mkXultra mkXultra deleted the chore/doc_org branch January 20, 2026 09:03
@github-actions
Copy link

🎉 This PR is included in version 2.4.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant