参与贡献

围绕一个明确问题提交聚焦的改动,保留现有行为边界,并提供能让维护者复现的验证结果。

本页内容

开始前明确范围

阅读仓库 README、AGENTS.md、架构和相关模块文档,先复现问题并查找已有实现。使用独立分支处理一个主题,确认工作区中哪些是自己已有的修改,不覆盖其他未提交工作。

非简单行为变化按仓库要求先建立或继续 OpenSpec change,写清使用场景、行为与验证任务,再实施。小型文档或明确文案修正保持范围,不为了修一个词改动整套界面。

不要修改无关的第三方或子模块内容。根目录只保留规范文档,临时日志、截图和构建产物放到合适位置,不加入一次性的根目录报告。

遵循模块与代码约定

C++ 使用 C++17,遵守 .editorconfig 的编码、换行与缩进。共享逻辑放入对应 src 子系统,TUI 渲染留在终端模块,React/Vite/Tailwind 源码留在 web/src。

新增用户可见字符串检查国际化映射与目录,避免一个入口显示中文而另一个出现未翻译字符串。新文件操作复用路径、编码和错误处理辅助函数,新增会话字段检查序列化、恢复与旧记录兼容。

API 行为变化同步 docs/daemon-api.md;用户体验变化同步本帮助包的内容源并重新生成静态 HTML。不要直接编辑应用的生成产物来代替源码修改。

按改动运行验证

改动类型验证
C++ 纯逻辑、解析与存储构建 acecode_unit_tests,运行对应测试与必要的完整测试。
Web 源码在 web 运行 pnpm test 与 pnpm build。
可见 TUI / 桌面交互在真实目标入口验证,并提供相关截图或终端记录。
平台桥接与打包验证对应平台运行条件、资源和配套后台。
静态帮助文档生成后检查目录、链接、搜索、图片占位和离线窄屏阅读。
已完成测试构建配置时
cmake --build build --target acecode_unit_tests
ctest --test-dir build --output-on-failure

测试应覆盖真实行为与错误边界。没有条件执行的平台检查在提交说明中明确标注,不把静态代码检查称为已经实际运行成功。

提交变更与参与讨论

提交信息简短描述具体动作。PR 说明首先交代问题与修改后的行为,再列验证结果、关联问题或 OpenSpec change。可见交互变化附相应画面,涉及 API 提供必要请求示例。

提交前检查差异,排除密钥、运行 Token、个人模型配置、会话记录、反馈包和无关产物。只提交当前任务需要的文件。

通过ACECode 仓库查看参与方式,通过Issues报告可复现问题。仓库当前使用 MIT License;发布或复用时保留相应许可说明。

搜索全部帮助文档