貢献ガイド

BlockTavern ドキュメントプロジェクトへの参加を歓迎します！このガイドは、迅速に始めて高品質な貢献を提出するのに役立ちます。

環境準備

システム要件

• Node.js 18+
• Git 最新バージョン
• GitHub アカウント

推奨開発ツール

• VS Code + Markdown 拡張機能
• GitHub Desktop（オプション）

画像最適化

ローカル画像を使用する前にファイルサイズを圧縮するか、安定した画像ホスティングサービスを使用して読み込み速度を向上させてください。

クイックスタート

1. プロジェクトをフォーク

1. プロジェクトリポジトリにアクセス：doc_blocktavern
2. 右上の Fork ボタンをクリック
3. フォークの完了を待つ

2. ローカル開発

# あなたのフォークをクローン
git clone https://github.com/YOUR_USERNAME/doc_blocktavern.git
cd doc_blocktavern

# 依存関係をインストール
npm install

# 開発サーバーを起動
npm run docs:dev

http://localhost:5173 にアクセスしてドキュメントサイトをプレビューします。

3. ブランチを作成

# 機能ブランチを作成
git checkout -b feature/your-feature-name

# または修正ブランチ
git checkout -b fix/your-fix-name

貢献フロー

1. コンテンツの作成

• docs/zh-CN/ ディレクトリでドキュメントを編集または作成
• ドキュメント作成規範 に従う
• リアルタイムプレビュー：保存後にブラウザが自動更新

2. 変更をコミット

# 変更されたファイルを追加
git add .

# 変更をコミット（規範的なコミットメッセージを使用）
git commit -m "docs: 新機能説明を追加"

# あなたのフォークにプッシュ
git push origin feature/your-feature-name

3. プルリクエストを作成

1. あなたのフォークリポジトリページにアクセス
2. Compare & pull request ボタンをクリック
3. PR情報を記入：
   • タイトル：変更内容を簡潔に説明
   • 説明：変更理由と影響を詳細に説明
4. Create pull request をクリック

4. レビューを待つ

• プロジェクトメンテナーがあなたのPRをレビューします
• 修正や補足を求められる場合があります
• レビューが通過すると、メインブランチにマージされます

コミット規範

コミットメッセージ形式

<type>(<scope>): <description>

[optional body]

[optional footer]

タイプ（type）：

• docs: ドキュメント更新
• feat: 新機能
• fix: 問題修正
• style: フォーマット調整
• refactor: リファクタリング

例：

git commit -m "docs(guide): インストールチュートリアルを追加"
git commit -m "fix(config): サイドバー設定エラーを修正"
git commit -m "feat(search): 検索機能を追加"

ブランチ命名規範

• feature/機能名: 新機能開発
• fix/問題説明: 問題修正
• docs/ドキュメントタイプ: ドキュメント更新
• refactor/リファクタリング内容: コードリファクタリング

貢献タイプ

ドキュメント貢献

• 新規ドキュメント：新しいガイドやチュートリアルの作成
• コンテンツ改善：既存ドキュメントの詳細情報を補完
• エラー修正：ドキュメント内の誤った情報を訂正
• 翻訳作業：中国語ドキュメントを他の言語に翻訳

技術貢献

• 設定最適化：VitePress設定の改善
• スタイル美化：ドキュメントサイトスタイルの最適化
• 機能強化：新しいドキュメント機能の追加
• パフォーマンス最適化：サイト読み込み速度の向上

品質基準

ドキュメント品質

• [ ] 内容が正確で間違いがない
• [ ] 言語表現が明確
• [ ] 構造階層が合理的
• [ ] コード例が実行可能
• [ ] リンクが有効でアクセス可能
• [ ] 画像が鮮明で適切

技術品質

• [ ] コードスタイルが一貫している
• [ ] 設定構文が正しい
• [ ] ビルドテストが通過
• [ ] 互換性が良好

ヘルプの取得

問題が発生した場合：

1. 既存ドキュメントを確認：プロジェクト構造、設定説明
2. Issueを提出：GitHubリポジトリで問題レポートを作成
3. メンテナーに連絡：GitHubまたはコミュニティチャンネル経由
4. 参考リソース：VitePress公式ドキュメント

---

ご貢献いただき、ありがとうございます！すべての貢献がBlockTavernドキュメントをより良いものにします。

# 貢献者

読み込み中...

# 変更履歴

読み込み中...

完全な履歴を表示

読み込み中...