リポジトリ規約

以下は、Luna-Flow のドキュメント標準に加えて mare_mark が定めるルールです。

機能の記述

各ページは現在のブランチが実装しているものを説明します。機能が利用可能として記述されるのは、コードとそれに焦点を当てたテストがその機能を実行している場合だけです。記録はされても動作には反映されないフィールドや enum のケース（例えば ValidationCoverage）はその旨を明記し、各設計ページはパッケージの境界で締めくくります。

パッケージのページ

cli 実行ファイルや小さな ir_sink ファサードを含むすべてのパッケージに、API ページ、チュートリアル、設計ページがあります。別個のパッケージリファレンスはありません。概要のパッケージ表から、各パッケージの 3 つのページすべてにリンクしています。report、runner、stats はさらに、マニュアルへのパッケージローカルな案内として、ソースの隣に短い README.mbt.md を置いています。

例

実行可能な例は、inspect または debug_inspect で出力を示す完全な test または async test ブロックで、検証で説明するとおりに検査されます。例では、計時値や実際の計測に基づく判断のような、マシンに依存する値を決して示しません。

単位と名前

時間は、ページで特に断らない限りマイクロ秒で、µs と書きます。相対差はパーセントです。スキーマ識別子（mmkp_1、mmka_1、mmks_1、mmkts_1）はアーティファクトに現れるとおり正確に書きます。

翻訳

コマンド、識別子、パッケージパス、スキーマ名、バージョン番号は、どの翻訳でも変更しません。