リポジトリ規約
これらの規則は、mooncake_impact_factor 向けに Luna-Flow のドキュメント標準を補うものです。このリポジトリは 3 つの MoonBit パッケージ(score、cli、static_search)、Python のインデックスビルダー、Next.js アプリケーションで構成されるため、ドキュメントはそのすべてと整合していなければなりません。
範囲
- ブランチ上の現在の
0.1.2ベースラインを説明します。 - 未公開のコマンド、ルート、フィールド、MoonBit のエクスポートは記述しません。
- ローカル限定の挙動は、グローバルなサービス契約があるかのように書かず、その旨を明記します。
整合性
README.md、CONTRIBUTING.md、マニュアルは同じリリースの経緯を説明しなければなりません。- API ドキュメントは、実際の MoonBit パッケージ名、関数シグネチャ、Next.js のルート契約と一致しなければなりません。
- Python スクリプトが安定した CLI フラグ、データベースの挙動、検索セマンティクスを公開する場合は、それを明示的に記述します。
- ローカルレジストリ上の事実と、mooncakes が権威を持つ事実を区別します。
- スコアの式、ランクのしきい値、モメンタムの規則は
src/scoreが持ち主です。設計ページはその性質をコードから導出するので、両者は同じコミットで変更してください。 - MoonBit の外で実装されている振る舞い(シグナルの集計、クエリの評価)は、それを使うガイドや設計ページで説明し、実装ファイルへのリンクを付けます。