DreamingAI - 企业级 AI 助手

Appearance

贡献指南 ​

感谢您对 DreamingAI 项目的关注！我们欢迎并感谢所有形式的贡献。

如何贡献 ​

报告问题 ​

如果您发现了 bug 或有功能建议，请通过 GitHub Issues 提交：

  1. 访问 GitHub Issues
  2. 搜索是否已有类似问题
  3. 如果没有，创建新的 Issue
  4. 详细描述问题或建议

提交代码 ​

  1. Fork 本仓库
  2. 创建您的特性分支 (git checkout -b feature/AmazingFeature)
  3. 提交您的更改 (git commit -m 'Add some AmazingFeature')
  4. 推送到分支 (git push origin feature/AmazingFeature)
  5. 打开一个 Pull Request

开发规范 ​

代码风格 ​

  • 使用 TypeScript 编写代码
  • 遵循 Vue 3 组合式 API 规范
  • 使用 Prettier 格式化代码
  • 提交前运行 pnpm format

提交信息规范 ​

提交信息应遵循以下格式：

<type>(<scope>): <subject>

<body>

<footer>

类型（type）：

  • feat: 新功能
  • fix: 修复 bug
  • docs: 文档更新
  • style: 代码格式调整（不影响代码运行的变动）
  • refactor: 重构
  • perf: 性能优化
  • test: 测试相关
  • chore: 构建过程或辅助工具的变动

示例 ​

feat(chat): 添加消息复制功能

- 添加右键菜单复制选项
- 支持快捷键 Ctrl+C 复制

Closes #123

开发流程 ​

  1. 讨论：对于重大更改，请先创建 Issue 进行讨论
  2. 开发：在本地分支上进行开发
  3. 测试：确保您的更改不会破坏现有功能
  4. 文档：更新相关文档
  5. 提交：创建 Pull Request

代码审查 ​

所有提交都需要经过代码审查：

  • 保持代码清晰和可维护
  • 添加必要的注释
  • 确保测试通过

许可证 ​

通过贡献代码，您同意将其授权给项目使用 Apache License 2.0。

联系我们 ​

如有任何问题，欢迎通过以下方式联系我们：

感谢您的贡献！