Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
136 lines (98 loc) · 2.46 KB

CONTRIBUTING.md

File metadata and controls

136 lines (98 loc) · 2.46 KB

贡献指南 | Contributing to GoldMind

感谢您考虑为 GoldMind 做出贡献！

🎯 贡献方式

  • 报告 Bug - 创建 Issue 描述问题
  • 建议功能 - 创建 Issue 提出建议
  • 编写代码 - 提交 Pull Request
  • 改进文档 - 完善 README 和代码注释

🚀 快速开始

1. Fork 并克隆

git clone https://github.com/YOUR_USERNAME/GoldMind.git
cd GoldMind

2. 搭建开发环境

参考 README.md 中的快速开始指南。

3. 创建分支

# 功能分支
git checkout -b feature/功能名称

# 修复分支
git checkout -b fix/bug描述

📋 开发规范

技术栈

后端

  • Python 3.11+
  • FastAPI
  • SQLAlchemy
  • MySQL

前端

  • React 18
  • TypeScript
  • Tailwind CSS

AI

  • LangChain
  • DeepSeek API
  • 智谱AI (Zhipu AI)

代码风格

Python

  • 遵循 PEP 8
  • 使用类型提示
  • 编写文档字符串

TypeScript

  • 使用严格模式
  • 有意义的变量名
  • 复杂逻辑添加注释

提交信息规范

feat: 添加新功能
fix: 修复 Bug
docs: 更新文档
refactor: 代码重构
test: 添加测试
style: 代码格式调整
chore: 构建/依赖更新

🏗️ 项目结构

GoldMind/
├── app/                    # 前端（React + TypeScript）
│   ├── src/
│   │   ├── sections/      # 页面区块
│   │   ├── components/    # 可复用组件
│   │   └── services/      # API 服务
│   └── package.json
├── backend/               # 后端（FastAPI + Python）
│   ├── app/
│   │   ├── agents/        # AI Agent
│   │   ├── services/      # 业务逻辑
│   │   ├── routers/       # API 路由
│   │   └── models/        # 数据模型
│   └── requirements.txt
└── README.md

🔒 安全规范

重要：永远不要提交以下敏感信息

  • API 密钥（DeepSeek、Zhipu AI 等）
  • 数据库密码
  • 私钥或证书

正确做法：

  • 使用 .env 文件存储敏感信息
  • 确保 .env 在 .gitignore 中
  • 提交前检查 git diff

🐛 报告 Bug

创建 Issue 时包含：

  • 问题描述
  • 复现步骤
  • 期望行为 vs 实际行为
  • 环境信息（OS、Python/Node 版本）
  • 错误日志

💡 建议功能

  • 使用场景
  • 建议方案
  • 替代方案（如有）

📄 许可证

通过贡献，您同意您的贡献将在 MIT 许可证下授权。

感谢您对 GoldMind 的贡献！