CONTRIBUTING.md

貢献者ガイド

ふぉーむがいどへの貢献に興味を持っていただきありがとうございます。ここにあなたがいることを私たちは嬉しく思っています。

初めてプルリクエストを提出する前に、このドキュメントを一度確認してください。また、類似の内容で既に誰かが作業していないか、オープンなイシューとプルリクエストを確認することを強くお勧めします。

何か助けが必要な場合は、@d151005 までお気軽にご連絡ください。

このリポジトリについて

このリポジトリでは主に以下のライブラリを使用しています。

• Next.js(App Router)
• shadcn/ui

構造

このリポジトリの構造は以下のようになっています。

├── app
├── components
│   └── ui
├── fields
└── lib

Path	Description
components/ui	アプリケーションで使用するコンポーネント
fields	ドキュメントの各フォームフィールド関連
lib	ヘルパー関数

開発

リポジトリのクローンから始める

git clone https://github.com/dninomiya/form-guide.git

依存関係のインストール

bun install
bun dev

http://localhost:3000/form-guide

/form-guide を末尾につける点に注意してください。

フォームフィールド

各フォームフィールドのディレクトリにあるファイルを編集すると自動的にドキュメントサイトに反映されます。誤字脱字を除いては、基本的には Discussions で合意を得た上でプルリクエストをお願いします。

└── fields
    ├── address
    │   ├── component.tsx # プレビュー
    │   ├── doc.mdx # ドキュメント
    │   ├── html.html # HTMLコード
    │   └── zod.ts # zodコード

zod のコードは実際に component.tsx で使用される点にご注意ください。（ただのサンプルコードではありません）

コミットコメント

内容がわかれば問題ありませんが、可能であればAngular Commit Message Guidelinesに準拠してください。

新しい機能やフォームフィールドのリクエスト

新しいコンポーネントや機能のリクエストがある場合は、GitHub でディスカッションを開始してください。お手伝いできることがあります。

テスト

現在テストはなく、実装予定もありませんが実装いただける場合プルリクエストをお願いします。