贡献指南

感谢您有兴趣为 InnoClaw 做出贡献！本指南介绍如何参与。

快速入门

  1. 在 GitHub 上 Fork 仓库

  2. 在本地克隆您的 Fork：

    git clone https://github.com/your-username/notebooklm.git
cd notebooklm

  3. 安装依赖：

    npm install

  4. 按照安装指南搭建开发环境

分支策略

  • main —— 稳定的生产分支

  • 功能分支 —— 从 main 创建，用于新功能或错误修复

分支命名规范

feature/short-description
fix/issue-number-description
docs/what-is-changing

提交规范

我们遵循 Conventional Commits 规范：

<type>(<scope>): <short description>

[optional body]

提交类型

类型

描述

feat

新功能

fix

错误修复

docs

文档变更

style

代码风格变更（格式化，无逻辑变更）

refactor

代码重构（无新功能或修复）

test

添加或更新测试

chore

构建流程或辅助工具变更

示例

feat(chat): add streaming response indicator
fix(files): handle special characters in filenames
docs(api): update endpoint documentation

Pull Request 流程

  1. 从 main 创建分支，使用描述性名称

  2. 进行更改并使用规范的提交消息进行提交

  3. 提交之前运行检查：

    npm run lint
npm run build
npm test

  4. 推送您的分支并打开 Pull Request

  5. 在 PR 描述中清楚地描述您的更改

  6. 等待审核 —— 维护者将审查您的代码

PR 检查清单

  • 代码遵循项目的编码风格

  • 测试通过（npm test）

  • Lint 通过（npm run lint）

  • 构建成功（npm run build）

  • 文档已更新（如适用）

行为准则

请在所有互动中保持尊重和建设性。我们致力于创建一个友好和包容的社区。

报告问题

  • Use GitHub Issues to report bugs or request features

  • 包含清晰的错误复现步骤

  • 提供环境详情（操作系统、Node.js 版本、浏览器）