貢献ガイド

Lindera への貢献に興味をお持ちいただきありがとうございます。このページでは、貢献を始めるためのガイドラインを紹介します。

はじめに

フォークをローカルにクローンします：

git clone https://github.com/<your-username>/lindera.git
cd lindera

リポジトリの既存のコードスタイルに従ってください。
コミット前に cargo fmt を実行してください。
すべての public および private アイテム（型、関数、モジュール、フィールド、定数、型エイリアス）にドキュメントコメント（///）を記述してください。
trait 実装メソッドにも、実装固有の振る舞いを説明するドキュメントコメントを記述してください。
関数・メソッドのドキュメントには、該当する場合 # Arguments と # Returns セクションを含めてください。
コードコメント、ドキュメントコメント、コミットメッセージ、ログメッセージ、エラーメッセージは英語で記述してください。
本番コードでは unwrap() や expect() を避けてください（テストコードでは使用可）。
unsafe ブロックは必要な場合にのみ使用し、必ず // SAFETY: ... コメントを付けてください。
モジュールは mod.rs スタイルではなく、ファイルベースのスタイル（src/tokenizer.rs）を使用してください。

すべての新機能にユニットテストを作成してください。
開発中は迅速なフィードバックのために関連するテストのみを実行してください：
```
cargo test -p <crate> <test_name>
```
train feature に関連する作業では、feature フラグを含めてください：
```
cargo test -p lindera-dictionary --features train
```

Conventional Commits の仕様に従ってください。コミットメッセージは英語で記述してください。

例：

変更がユーザー向けドキュメントに影響する場合は、docs/src/ 配下の関連ファイルを更新してください。
Markdown ファイルの編集後は、リントエラーがないことを確認してください：
```
markdownlint-cli2 "docs/src/**/*.md"
```
ルールはリポジトリルートの .markdownlint.json で設定されています。

新しい依存関係を追加する際は、ライセンスの互換性を確認してください。Lindera は MIT / Apache-2.0 デュアルライセンスを使用しています。

学習関連コードの条件コンパイルには #[cfg(feature = "train")] を使用してください。完全なリストは Feature フラグを参照してください。

バグを報告する際は、以下の情報を含めてください：