貢獻
本節適用於對 Neat Library 程式碼庫本身進行修改的貢獻者。它說明了程式碼庫的結構、如何建置和測試修改，以及應用程式開發人員必須維持哪些合約的穩定性。
貢獻者說明會
Neat Library 是此儲存庫中的 C++/Python 函式庫和執行階段。 它會載入模型封存檔，組成和驗證管線，在 Modalix 硬體上執行，並公開公用應用程式 API。Neat SDK 和 DevKit Sync 是周圍的開發工作流程。
在修改此儲存庫時，請針對有助於人類和代理協助開發的框架屬性進行最佳化：明確的 API、確定性行為、結構化的診斷、嚴格的驗證以及穩定的公用合約。
貢獻者原則
- 確定性至關重要 — 保持元件名稱、產生的管線、報告和測試的可重現性。
- 可除錯性是首要考量 — 錯誤應產生結構化資料，而不僅僅是字串。
- 不允許靜默回退 — 不要隱藏模型輸入錯誤或硬體/執行階段失敗。
- 在執行前進行驗證 — 在執行階段之前，找出結 構、上限、形狀和合約錯誤。
- 公開 API 必須保持穩定 — 在
include/*下安裝的標頭檔，需要進行增量且相容的變更。 - 並行處理必須受到限制且可觀察 — 關閉時不應發生死鎖，且診斷工具必須是執行緒安全的。
從這裡開始
在修改程式碼之前，請先了解程式碼庫、命名規則和相關規範。
建置與測試
建立框架、驗證變更，並處理 Python 繫結。
合約與內部事務
在變更模型封存檔、外掛合約或內部封裝時，請使用這些設定。
發布與維護
將這些用於發布流程、清理計畫和長期設計指導。