跳转至

开发

F-Layer 使用 master 进行稳定发布,使用 develop 进行集成,并在范围明确的 feature/* 或 fix/* 分支上实现变更。Pull request 以 develop 为目标并需要人工审核。

修改前请阅读 AGENTS.md 和开发协议。

Python 验证

python -m pip install -e ".[dev]"
python -m compileall -q src tests tools
python -m ruff check .
python -m mypy
python -m pytest

源码、注释、文档字符串、测试和规范文档均使用英文。Python 风格契约是权威规则。

基础设施安全

本地测试使用模拟对象、固定测试数据和确定性数据,不创建、更新或删除真实云资源。文档发现不会导入 F-Layer 运行时包。

构建本参考文档

python tools/build_api_reference.py

该命令构建 wheel,并在隔离环境中安装它及所有版本固定的文档工具。它生成严格的 MkDocs 输出,检查精确的渲染锚点和本地链接,验证语言元数据,并在 _build/api-reference/ 中记录 wheel 来源。

Markdown 表格按每列最宽单元格补齐,方便阅读原文。使用 python -m tools.markdown_tables 检查所有已跟踪 Markdown;使用 python -m tools.markdown_tables --write 执行明确请求的纯空白对齐。代码块中的示例不会改变。文档构建会拒绝表格漂移以及失效链接和锚点。

python tools/build_api_reference.py --serve

预览在 127.0.0.1:8000 使用同一份已验证的安装包输出。发布和本地化详情见文档规则。