ドキュメントDocumentationContributingIntroduction

はじめに

オープンソース化された Appbox フロントエンドの公式ドキュメントへようこそ。

Appbox ドキュメントへようこそ
Appbox のフロントエンドが GitHub でオープンソース化されたことをお知らせします。私たちの目的は、ドキュメントへの貢献、新しいフロントエンド機能の開発、Appbox 体験全体の改善に協力するコミュニティを育てることです。

ドキュメントはまだ初期段階ですが、同分野の他プラットフォームと同じように、包括的なリソースを構築していく予定です。現時点では主に貢献ガイドラインを中心にしていますが、今後 Appbox で利用できるすべてのアプリについて詳細情報を拡充していきます。

ドキュメントがさらに充実するまでは、特定のアプリやサービスに関するすぐの質問には 従来のナレッジベース をご利用ください。技術サポートが必要な場合は、チケットを送信 して支援を受けられます。サイトのフッターにあるリンクからいつでも新しいドキュメントにアクセスし、拡充状況を確認できます。

今後の予定

  • 詳細なアプリガイド
    当社プラットフォームで対応している各アプリについて、インストール、トラブルシューティング、ヒントを扱います。
  • ユーザーと開発者向けリソース
    初心者向けチュートリアルから Appbox 体験をカスタマイズするための高度なコードリファレンスまで提供します。
  • コミュニティ主導のコンテンツ
    Pull Request、フィードバック、提案を歓迎します。すべてが、このプロジェクトを誰にとってもより良いものにする助けになります。

はじめ方

オープンソース化されたフロントエンドコードを確認または貢献したい場合は、Appbox リポジトリをクローンしてください。

git clone https://github.com/appbox-co/appbox.git

次にプロジェクトへ移動し、依存関係をインストールします。

cd appbox
pnpm install
pnpm dev

ローカルインスタンスは http://localhost:3000 で利用できます。自由に探索し、変更を加え、Pull Request を作成してください。すべての貢献に感謝します。

開発ツール

Lint

このプロジェクトには、TypeScript と Prettier 統合を備えた ESLint による包括的な lint 設定が含まれています。これにより、一貫したコードスタイルを維持し、一般的なエラーを早期に検出できます。lint チェックは手動で実行できます。

# Run linting
pnpm lint
 
# Fix automatically fixable issues
pnpm lint:fix

ESLint 設定には次が含まれます。

  • @typescript-eslint による TypeScript 固有ルール
  • eslint-config-next による Next.js 固有 lint
  • Prettier 統合によるコードフォーマット

Pre-commit フック

Git フックの管理には Husky を使用しています。これにより、品質の高いコードだけがリポジトリにコミットされるようにしています。次のフックが設定されています。

  • pre-commit: 各コミット前に lint:fix を実行し、コード品質を確認します
  • commit-msg: commitlint を使用して conventional commit メッセージ形式を強制します

つまり、コミットは受け入れられる前にコード品質と適切な形式が自動的にチェックされ、コードベース全体で高い基準が維持されます。

Pull Request の作成

変更を貢献する準備ができたら、Pull Request（PR）が受け入れられやすくなるよう、次のガイドラインに従ってください。

PR 作成前

  1. 最新の main ブランチから rebase して、マージ競合を避けます。

    git checkout main
git pull origin main
git checkout your-branch
git rebase main

  2. すべての lint が通ることを確認 します。

    pnpm lint:fix

  3. 関連する機能をテストして、コードがローカルで動作することを確認 します。

PR ガイドライン

  1. PR は焦点を絞る - 1つの Issue または機能につき、1つの PR にしてください。
  2. 明確なコミットメッセージを書く - conventional commit 形式に従ってください。
  3. 分かりやすい説明を含める - PR が何を行い、なぜ必要なのかを説明してください。
  4. テストを追加する - 該当する場合は、変更が正しく動作することを確認するテストを追加してください。
  5. コードを文書化する - 複雑なロジックにはコメントを使い、関数名が説明的であることを確認してください。
  6. 既存パターンに従う - コードはコードベースの他の部分で使われているスタイルやパターンに合わせてください。

大きな変更の場合は、コーディングに時間をかける前に、まず Issue を開いて方針を相談することを検討してください。これにより、あなたの貢献がプロジェクトの方向性に合っていることを確認でき、無駄な作業を避けられます。

OpenClaw model provider setupAdding new docs