跳转到内容

参与贡献

这是一个小型的、配置驱动的仪表盘模板。欢迎添加新的提供商适配器、修复 bug 或改进文档的贡献。如果贡献涉及多租户认证、插件市场或其他远超”单用户运维仪表盘”范围的内容,最好通过 fork 实现——如果不确定,请先开一个 issue。

  • 提交: 约定式提交,单行,除非有特殊原因否则不写正文。由 commitlint + Husky 强制执行。
  • 测试: 放在 src/tests/ 下,镜像源代码树——不要将 *.test.ts 与实现文件放在一起。已启用 Vitest 全局变量。
  • 格式化/代码检查: npm run format(Prettier,单引号,printWidth: 140),npm run lint(ESLint)。提交 PR 前两者都应通过。
  • 构建: npm run build 应该通过。
  • CI: .github/workflows/ci.yml 在每个 PR 上运行测试、代码检查和构建。
  • 为提供商适配器添加模拟测试——不要让 PR 依赖于调用真实的外部服务。

完整的步骤指南请参阅专门的指南

此工具仅采集聚合运维信号。新适配器不得改变这一原则。完整的数据安全规则请参阅架构页面

永远不要提交凭证、API 密钥、service-role key、.envprojects.config.json。如何报告漏洞请参阅安全页面