開発者向けガイドライン
VisionAssist ALT GPTs は、X の ALT 機能向けに画像認識と OCR を用いて画像内テキストや重要情報を自動生成するオープンソースプロジェクトです。コントリビューションの前に、本ガイドラインをご確認ください。リポジトリは GitHub で公開しています。
基本方針
- 小さな変更から歓迎します（UI の微調整、文言修正、ドキュメント改善など）。
- Issue には背景・課題・提案・再現手順（必要に応じて）を簡潔に記載してください。
- UI に影響する PR はスクリーンショット/動画の添付を推奨します。
- 本プロジェクトのライセンスはリポジトリ記載の内容に従います。投稿物は同条件で再配布・改変される場合があります。
ブランチと PR の流れ
- リポジトリをフォークし、作業用ブランチを作成（例: feat/xxx, fix/xxx）。
- アクセシビリティと可読性を意識して実装（フォーカス、コントラスト、ARIA 属性、代替テキスト）。
- ローカルで npm run lint を実行し、ビルドが通ることを確認。
- PR 作成時に目的・変更点・影響範囲・スクショ/動画（UI 変更時）・関連 Issue を記載。
- レビューコメントには丁寧に対応し、必要に応じて追従コミットを行ってください。
コーディング規約 / アクセシビリティ
- TypeScript/React（Next.js）・Tailwind の既存スタイルに合わせること。
- ESLint/Prettier（プロジェクト設定）に従い、Lint エラーを残さないこと。
- コンポーネントは再利用性と読みやすさを重視し、適切な命名を行うこと。
- 色コントラスト、キーボード操作、フォーカス指標、代替テキストを必須とします。
- アニメーションは控えめにし、ユーザーの注意を補助する目的に限定します。
コミットメッセージ規約
Conventional Commits を推奨します。
- feat: 機能追加
- fix: バグ修正
- docs: ドキュメントのみの変更
- style: 動作に影響しないスタイル変更（フォーマット等）
- refactor: リファクタリング
- chore: ビルド/ツール/設定類
セキュリティ
- 脆弱性は公開の Issue では詳細を伏せ、再現に不要な情報の開示を避けてください。
- 悪用可能な内容は、再現最小限で報告するか、メンテナへ事前連絡を検討してください。
第三者コンテンツ
- 著作権・ライセンスを確認できる素材のみを使用してください（画像・フォント・コード等）。
- 出典が必要な場合は README やコメントで明記してください。
コントリビューションのライセンス
PR を送信することで、投稿者は当該貢献物について、リポジトリ記載のライセンス条件の下での利用・改変・再配布を許諾したものとみなします。第三者の権利を侵害しないことを保証してください。