コントリビューション

zudo-docへの貢献方法、プロジェクトの背景とメンテナンス方針について。

背景

zudo-docはTakazudoがドキュメンテーションフレームワークとして作成しました。もともとは個人利用のために構築されたもので、複数のプロジェクトで繰り返し必要になるワークフローやデザインの好みに合わせた、Docusaurusの軽量な代替として開発されました。

時間の経過とともに、16色ターミナルパレットシステム、MDXコンテンツコレクション、i18nサポート、Claude Code連携などの機能を備えた独立したフレームワークへと成長しました。

開発

このプロジェクトのソースコードの大部分はClaude Codeの助けを借りて書かれています。フレームワークはMITライセンスの下で公開されています。

メンテナンス

このプロジェクトはベストエフォートベースでメンテナンスされています。積極的なメンテナンスやコントリビューションの徹底的なレビューには限りがある場合があります。

公式サポートを待つよりも、リポジトリをフォークして必要な変更を自分で実装することをお勧めします。AI時代においては、フォークしてカスタマイズする方がアップストリームの変更を待つよりも速いことが多いです。

貢献方法

貢献したい場合は：

1. GitHubでリポジトリをフォーク
2. mainからトピックブランチを作成
3. 変更を加え、pnpm b4pushがパスすることを確認（型チェック、ビルド、E2Eテスト、フォーマットチェック）
4. 変更内容と理由を明確に記述してプルリクエストを作成

バグ報告や機能リクエストはGitHub Issuesで受け付けています。

ライセンス

zudo-docはMITライセンスの下で公開されています。

著者

• 高津戸 壮 (@Takazudo)