Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
93 lines (67 loc) · 1.66 KB

CONTRIBUTING.md

File metadata and controls

93 lines (67 loc) · 1.66 KB

贡献指南

感谢您考虑为 Vue AI Stream Helper 做出贡献！

如何贡献

报告 Bug

如果您发现了 Bug，请：

  1. 在 Issues 中搜索，确保该问题尚未被报告
  2. 创建新的 Issue，包含：
    • 清晰的标题和描述
    • 重现步骤
    • 预期行为和实际行为
    • 您的环境信息（Vue版本、浏览器等）
    • 相关代码示例

提出新功能

  1. 创建 Issue 描述您的想法
  2. 说明为什么需要这个功能
  3. 等待维护者的反馈

提交代码

  1. Fork 仓库
  2. 创建特性分支 
    git checkout -b feature/amazing-feature
  3. 进行更改
  4. 提交更改 
    git commit -m 'feat: add amazing feature'
  5. 推送到分支 
    git push origin feature/amazing-feature
  6. 开启 Pull Request

开发设置

# 克隆仓库
git clone https://github.com/yourusername/vue-ai-stream-helper.git

# 安装依赖
cd vue-ai-stream-helper
npm install

# 开发
npm run dev

# 构建
npm run build

代码规范

  • 使用 ES6+ 语法
  • 遵循 ESLint 规则
  • 添加必要的注释
  • 保持代码简洁

提交规范

使用 Conventional Commits：

  • feat: 新功能
  • fix: Bug修复
  • docs: 文档更新
  • style: 代码格式
  • refactor: 重构
  • test: 测试
  • chore: 构建/工具

测试

在提交 PR 前，请确保：

  • 代码通过 lint 检查
  • 所有测试通过
  • 添加了必要的测试用例
  • 文档已更新

问题？

有任何问题，请创建 Issue 或联系维护者。

谢谢！❤️