
FreeLLMAPI贡献者指南开发循环、测试要求与PR规范完整手册【免费下载链接】freellmapi7.4 billion tokens per month. 34 free LLM providers. 635 free model endpoints. All behind one /v1 endpoint, plus any custom OpenAI-compatible endpoint. Smart routing, automatic failover, encrypted keys. Personal experimentation only.项目地址: https://gitcode.com/GitHub_Trending/fr/freellmapiFreeLLMAPI是一个本地优先的免费大模型API聚合器34 个免费 LLM 提供方、635 个免费模型端点全部聚合在一个/v1接口之后并支持智能路由、自动故障切换和加密密钥管理。想参与开源却不知从何下手本文就是面向新手的FreeLLMAPI 贡献者指南完整讲清开发循环、测试要求与 PR 规范带你走完从环境搭建到合并 PR 的全流程 为什么适合新手四类贡献方向项目维护者在 CONTRIBUTING.md 中明确列出了最常见的贡献方向新增提供方Provider以 openai-compat.ts 为模板复制一份接入 index.ts并补充测试➕新增端点Endpoint如 moderations 等 OpenAI 兼容接口改进路由器Router成本感知路由、延迟加权优先级、区域绑定仪表盘打磨分析页图表、密钥轮换交互、批量导入体验所有细节可见 README.md 中的 Good first PRs 清单非常适合第一个 PR 练手。一键搭建环境开发循环 5 条命令环境要求Node.js ≥ 20.18.0 且 25.0.0npm ≥ 10.0.0见 package.json 的engines字段。首次克隆仓库后推荐运行官方引导脚本它会自动检查版本、仅在锁文件变化时安装依赖、并在缺失时创建.env./scripts/dev-bootstrap.sh # Linux / macOSWindows 用户可运行 PowerShell 版scripts/dev-bootstrap.ps1。脚本源码可参考 dev-bootstrap.sh。日常开发循环只有 5 条命令全部来自 CONTRIBUTING.md命令作用npm install安装全部工作区依赖npm run dev启动服务端:3001 仪表盘:5173均支持热更新npm run db:migration:up将迁移应用到本地数据库npm test运行服务端 / CLI / 客户端测试npm run build编译服务端与仪表盘测试要求每个 PR 必须守住的两条线测试是这个项目贡献门槛的核心规则非常明确每个 PR 必须附带测试并且要保住现有测试套件全绿npm test风格上对齐仓库已有的.editorconfig与 tsconfig 默认配置一个容易踩的坑仓库的npm test不只跑服务端还会串联 bootstrap 脚本测试、commit hook 测试以及 CLI 与客户端测试见 package.json 的test脚本。所以提交前本地完整跑一遍npm test能避免 CI 返工。数据库迁移规范文件即迁移禁止回改FreeLLMAPI 采用一个文件一次迁移file-per-migration策略所有模式变更必须放在server/src/db/migrations/目录完整规则见 server/src/db/README.mdnpm run db:migration:create --nameadd_embedding_index # 新建迁移文件 npm run db:migration:up # 应用迁移 npm run db:migration:down # 回滚 npm run db:migration:status # 查看已执行状态⚠️ 三条铁律绝不修改已应用的旧迁移文件db:migration:fresh仅限本地开发或测试使用生产环境严禁执行内置模型目录数据新增/下线/修正默认模型也必须通过新的前向迁移提交翻译贡献60 种语言的校验器仪表盘内置 60 种语言文件en.json是唯一事实源其他语言文件必须与其键完全对齐。开 PR 前务必在client/下运行npm run check:i18n该校验器会检查全部 60 个语言文件的键一致性、值类型和{placeholder}占位符匹配实现见 check-i18n.mjs。完整规则与已定型的中文术语表如词元 vs 令牌之争请阅读 docs/translating.md翻译时保持一个 PR 只改一个语言会大幅提升合并速度。PR 规范小而专拒绝付费服务除了测试要求每个 PR 还需满足以下规范摘自 CONTRIBUTING.md✅单一改动一个 PR 只做一个变更小 PR 合并更快✅免费优先禁止添加需要付费或绑卡的服务——目录只收录真正免卡可用的免费档✅风格一致遵循.editorconfig与 tsconfig 默认约定AI 辅助贡献欢迎但标准相同项目对 LLM 辅助 PR 态度开放——代码库本身就大量以此方式构建。但标准与其他 PR 完全一致核心四条理解自己的 diff评审问起每一行你必须答得上来真实测试要运行代码而不是只跑提示词不能真正覆盖改动的测试比没有更糟收敛范围AI 工具顺手重排、重命名无关文件的内容必须剔除禁止编造事实提供方的速率限制、模型 ID、端点必须对照官方核实——目录里写错的限流是会发给所有用户的 bug未经验证明显是模型生成的 PR大范围无法解释的 diff、捏造的限流、跑不通的测试会被要求修改或直接关闭。提交 Issue三个关键信息Bug 报告最有价值的三要素你的版本或 commit、涉及的提供方、可分享时的原始请求与响应。对于校验或路由类问题失败请求前后的服务端日志帮助极大。准备好动手了吗从 README.md 的 Good first PRs 清单里挑一个方向按本文的5 条命令 2 条测试线 3 条迁移铁律执行你的第一个 FreeLLMAPI PR 离合并只差一次npm test全绿 【免费下载链接】freellmapi7.4 billion tokens per month. 34 free LLM providers. 635 free model endpoints. All behind one /v1 endpoint, plus any custom OpenAI-compatible endpoint. Smart routing, automatic failover, encrypted keys. Personal experimentation only.项目地址: https://gitcode.com/GitHub_Trending/fr/freellmapi创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考