【免费下载链接】Axl
Axl 是一个 local-first 代理框架(local-first agent harness):一个 daemon 完整拥有你的编码会话,终端、浏览器和 SDK 都只是它的一个个窗口。项目处于早期快速演进阶段,代码、文档、设计都欢迎共建。这篇文章带你认识 Axl 社区的两大主阵地——GitHub 与 Discord,并给出从"提一个 Issue"到"合入第一个 Pull Request"的完整上手路径。
社区在哪里:两个入口找到所有人
| 渠道 | 适合做什么 | 特点 |
|---|---|---|
| GitHub 仓库 | 提 Bug、提功能建议、认领开发任务、提交 Pull Request、参与设计讨论 | 所有正式决策都记录在 issue 和 PR 中,可追溯 |
| Discord 服务器 | 实时交流、使用答疑、功能讨论、结识其他贡献者 | 官方 README 首页徽章直接提供入口,氛围友好 |
💡 建议:把"要落到代码里的讨论"放在 GitHub issue(方便引用和追踪),把"随手问一句"的即时交流放在 Discord。
动手之前:先读这 5 份社区文档
Axl 社区文档分工清晰,贡献前建议按顺序浏览(完整清单见 docs/DEVELOPMENT_GUIDE.md 的 Community standards 一节):
| 文档 | 一句话说明 |
|---|---|
| CONTRIBUTING.md | 贡献总则:环境要求、分支规范、DCO 签名、PR 流程 |
| docs/DEVELOPMENT_GUIDE.md | 最完整的贡献者工作流:从环境搭建到提交清单 |
| GOVERNANCE.md | 治理模式(BDFL 制)与当前决策权归属 |
| CODE_OF_CONDUCT.md | 社区行为准则,适用于仓库、issue、评审与聊天区 |
| SECURITY.md | 安全漏洞的私有报告渠道与响应时效 |
另有 AI_POLICY.md 专门规范 AI 辅助开发:AI 可以帮你写代码,但必须由一个"具名的人"负责指导、审阅完整 diff、验证声明并披露使用的工具与模型版本。
第一类贡献:用 Issue 参与(门槛最低)
Axl 为最常见的三种诉求准备了结构化模板,位于 .github/ISSUE_TEMPLATE/:
1. 报告 Bug(bug.yml)
标题自动带[Bug]前缀,模板要求填写:
- 复现步骤(最小可复现序列)
- 预期行为 vs 实际行为
- Axl 版本(release 版本号或 Git commit)
- 环境信息(操作系统、架构、Node.js 版本、沙箱 provider)
⚠️ 提交前务必先搜索已有 issue 去重,并删除日志中的凭据和隐私数据。
2. 提议功能(feature.yml)
描述"用户问题"而不是直接给方案:说明问题、期望结果、备选方案,以及对协议、格式、权限或信任边界的影响。
3. 建议采纳目标(adoption-target.yml)
Axl 内置 adoption compiler,可以把 OpenCode、Claude Code 等生态的插件转成原生扩展。如果你有想支持的第三方 agent 资源,用这个模板提交:来源生态、包名、源地址、需要保留的行为。
关于重大设计变更
涉及 kernel 保证、事件格式、扩展 API 或 wire protocol 的改动,必须先在 issue 中讨论设计再动手实现,并在变更中附带兼容性说明(见 CONTRIBUTING.md 的 Find and claim work 一节)。
第二类贡献:动手改代码,合入第一个 PR
步骤一:准备开发环境
| 工具 | 版本要求 | 用途 |
|---|---|---|
| Node.js | ^22.19.0或>=24 | 运行 TypeScript、测试、构建 |
| pnpm | 10.34.4 | workspace 依赖管理 |
| Git | 维护中的版本 | 分支工作流 |
| Python + uv + REUSE | 3.11+/ 最新 /6.2.0 | 本地许可证检查 |
步骤二:克隆仓库并本地运行
git clone https://gitcode.com/gh_mirrors/axl/Axl.git cd Axl pnpm install --frozen-lockfile pnpm checkpnpm check会一次跑完格式化、lint、类型检查、测试、包边界与生成文件检查。建议在改任何代码前先完整跑一遍,作为本地基线(更多说明见 SETUP.md)。
步骤三:建分支并遵守规范
- 分支名短而有描述,如
feature/event-schema、fix/log-recovery、docs/setup - 永远不要直接提交到
main - 提交信息用简洁的 conventional commit,并为每个 commit 做 DCO 签名:
git commit --signoff -m "docs: expand development guide"- 应用代码用 TypeScript,优先使用 Node.js 内置模块;新增生产依赖前需先征求意见
- 包边界是硬规则(
pnpm check:boundaries强制检查):packages/protocol零运行时依赖,packages/kernel只依赖 protocol 和 Node 内置模块,扩展只能使用公共包导出 - 不要手改生成文件:改它的源头或生成器,再生成(生成文件统一以
*.generated.ts结尾)
步骤四:提交 Pull Request
打开 PR 前,仓库内置的模板(.github/pull_request_template.md)会引导你填写:
- Purpose / Fixes:解决什么问题,关联哪个 issue
- Approach:改动思路,以及兼容性与安全影响
- How was this tested?:列出实际运行的每条命令与结果,如实说明哪些没测
- Checklist:完整审阅 diff、最小回归测试、各类检查通过、SPDX 元数据、DCO 签名
- AI assistance:披露生成式 AI 是否实质性参与了改动,以及工具与模型版本
TUI 类可见变更请在 PR 中附上截图(截图不要提交进仓库)。
合入条件
受保护分支需要两次人工批准加 BDFL 批准。当前项目处于 bootstrap 阶段,由创始人兼任维护者(详见 GOVERNANCE.md)。CI 会同时跑构建测试、Biome、类型检查、包边界、生成文件、REUSE 许可、DCO 检查,外加 CodeQL 静态分析、依赖审查和 Gitleaks 密钥扫描——所以提交前把pnpm check和reuse lint跑绿,能少走很多弯路。
社区规范:几件容易踩线的事
- 行为准则:对事不对人、给具体有用的反馈、接受纠正;政策覆盖仓库、issue、评审和聊天区(CODE_OF_CONDUCT.md)
- 许可证合规:每个新文件都要带 SPDX 版权头(无法写注释的文件走
REUSE.toml),提交前用reuse lint自查 - 安全漏洞别发 issue:疑似漏洞请通过 GitHub Private Vulnerability Reporting 或邮件私有报告,沙箱逃逸、权限绕过、凭据泄露属于最高严重级(SECURITY.md)
- 不要提交无人看管的 AI 生成成果:占位 API、照搬实现、与任务无关的大重构都会被拒
现在就加入
- 给仓库点个Star,让更多人找到这个项目
- 加入Discord服务器(README 首页徽章直达),先看看大家在聊什么
- 翻一遍 ROADMAP.md,用 issue 模板提一个你关心的 Bug 或建议
- 准备好后,按上面的四步流程提交你的第一个 PR
Axl 还在 pre-1.0,路线图上 adoption compiler、目标模式、子代理、学习回路等特性都在排队——早加入的社区成员,能真切看到自己的名字写进 RELEASES.md 里的第一批发布记录。
【免费下载链接】Axl
相关推荐
Rolldown 社区参与指南:如何加入这个激动人心的项目
Rolldown 社区参与指南:如何加入这个激动人心的项目 Rolldown 是一个用 Rust 编写的 JavaScript 打包工具,旨在成为 Vite 未
构建工具前端构建开发工具终极指南:如何为Artemis开源MEV框架贡献代码并成为社区明星
终极指南:如何为Artemis开源MEV框架贡献代码并成为社区明星 Artemis是一个用Rust编写的简单、模块化且快速的MEV机器人框架,它为开发者提供了构
Windows 11性能优化终极指南:针对不同硬件配置的完整建议
Windows 11性能优化终极指南:针对不同硬件配置的完整建议 想要让您的Windows 11系统运行如飞吗?无论您是拥有高端游戏PC还是普通办公笔记本,这份
文档教程知识库
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考