跳转至

贡献指南

开发环境

uv venv
uv sync --all-groups

代码质量(后端)

just lint

或:

uv run pre-commit run --all-files

测试

just test

前端构建检查

Demo Frontend

cd demo-frontend
npm ci
npm run build

Admin Frontend

cd admin-frontend
npm ci
npm run build

文档构建

uv run mkdocs build

如需本地预览:

just mkdocs-serve

PR 合并规则(CI 对齐)

  • 目标分支为 main 的 Pull Request 会自动触发 GitHub Actions CI。
  • 以下检查失败会阻止合并:
  • 后端依赖同步、just lintjust test
  • uv run mkdocs build
  • demo-frontendadmin-frontend 生产构建
  • 建议在本地先按以下顺序执行一遍,减少 CI 失败重跑:
uv sync --all-groups
just lint
just test
uv run mkdocs build