跳到主要内容

为 Kilo Code 做贡献

Kilo Code 是一个开源项目,欢迎所有技能水平的开发者贡献代码。本指南将帮助你开始为 Kilo Code 做出贡献,无论是修复错误、添加功能、改进文档还是分享自定义模式。

贡献方式

有多种方式可以为 Kilo Code 做出贡献:

  1. 代码贡献:实现新功能或修复错误
  2. 文档:改进现有文档或创建新指南
  3. 自定义模式:创建并分享专用模式
  4. 错误报告:报告你遇到的问题
  5. 功能请求:建议新功能或改进
  6. 社区支持:在社区中帮助其他用户

设置开发环境

设置开发环境的详细说明请参阅此页面

开发工作流

分支策略

  • 为每个功能或错误修复创建一个新分支
  • 使用描述性的分支名称(例如 feature/new-tool-supportfix/browser-action-bug
git checkout -b your-branch-name

编码标准

  • 遵循现有的代码风格和模式
  • 新代码使用 TypeScript
  • 为新功能包含适当的测试
  • 更新文档以反映任何面向用户的更改

提交指南

  • 编写清晰、简洁的提交信息
  • 在适用时引用问题编号
  • 保持每次提交专注于单一更改

测试你的更改

  • 运行测试套件:
    npm test
  • 在开发扩展中手动测试你的更改

创建拉取请求

  1. 将你的更改推送到你的 fork:

    git push origin your-branch-name
  2. 前往 Kilo Code 仓库

  3. 点击 "New Pull Request" 并选择 "compare across forks"

  4. 选择你的 fork 和分支

  5. 填写 PR 模板,包括:

    • 更改的清晰描述
    • 任何相关问题
    • 测试步骤
    • 截图(如适用)

创建自定义模式

自定义模式是扩展 Kilo Code 功能的强大方式。要创建并分享自定义模式:

  1. 按照 自定义模式文档 创建你的模式

  2. 彻底测试你的模式

  3. 通过提交 GitHub Discussion 与社区分享你的模式

文档贡献

文档改进是非常有价值的贡献:

  1. 遵循文档风格指南:

    • 使用清晰、简洁的语言
    • 在适当时包含示例
    • 使用以 /docs/ 开头的绝对路径作为内部链接
    • 不要在链接中包含 .md 扩展名
  2. 通过本地运行文档站点测试你的文档更改:

    cd docs
    npm install
    npm start
  3. 提交包含文档更改的 PR

社区准则

参与 Kilo Code 社区时:

  • 保持尊重和包容
  • 提供建设性的反馈
  • 帮助新手入门
  • 遵守 行为准则

获取帮助

如果你需要帮助:

致谢

所有贡献者都是 Kilo Code 社区的重要成员。贡献者将在以下地方获得认可:

  • 发布说明
  • 项目的 README
  • GitHub 上的贡献者列表

感谢你为 Kilo Code 做出贡献,帮助让 AI 驱动的编码辅助对每个人更好!