Skip to content

CONTRIBUTING.ja.md

Latest commit

 

History

History
79 lines (55 loc) · 2.53 KB

CONTRIBUTING.ja.md

File metadata and controls

79 lines (55 loc) · 2.53 KB
Raw

lexdiffへのコントリビュート

lexdiffへの貢献に興味を持っていただきありがとうございます。このプロジェクトは、法令改正の履歴をGitHub風の差分表示で可視化し、誰でもアクセスできるようにすることを目指しています。

受け入れるコントリビューション

  • バグ修正やUI/UXの改善
  • データパイプラインの強化（新しい法令の追加、差分アルゴリズムの改善）
  • アクセシビリティ、パフォーマンス、インフラの改善
  • ドキュメントの改善・翻訳

コントリビューションの方法

Issue の報告

  • GitHub Issues でバグ報告や機能提案を行ってください
  • バグ報告には再現手順を含めてください
  • 機能提案にはユースケースを説明してください

プルリクエスト

  1. リポジトリをフォーク
  2. フィーチャーブランチを作成（git checkout -b feature/your-feature）
  3. 変更を実装
  4. Lintを実行（cd frontend && npm run lint）
  5. わかりやすいコミットメッセージでコミット
  6. プッシュしてプルリクエストを作成

開発環境のセットアップ

git clone https://github.com/wharfe/lex-diff.git
cd lex-diff

# Pythonパイプライン
uv sync

# フロントエンド
cd frontend
npm install
npm run dev -- -p 3002

ガイドライン

コード

  • TypeScript strictモード
  • コード内のコメントは英語
  • ユーザー向けテキストは日本語
  • スタイリングにはTailwind CSSを使用
  • 既存のコードパターンに従う

AIプロンプト

AIプロンプト（要約、注釈生成など）の変更には慎重なレビューが必要です：

  • 変更の理由を説明すること
  • 変更前後の生成結果の例を示すこと
  • プロンプトの変更は少なくとも1人の他のコントリビューターによるレビューを必須とする

コミット

  • わかりやすいコミットメッセージを記述する
  • 関連するIssue番号があれば参照する

助けが必要な領域

  • 対象法令の追加と差分データの生成
  • フロントエンドコンポーネントとUI改善
  • アクセシビリティ（a11y）の強化
  • パフォーマンス最適化
  • ドキュメントと翻訳
  • AIプロンプトの改善
  • テスト

質問がありますか？

GitHub Issue を作成してください。