open-git/nofx

Fork 0

mirror of https://github.com/NoFxAiOS/nofx.git synced 2025-12-06 13:54:41 +08:00

Files

zbhan a1bf54b952 feat: pr validation

2025-11-01 18:25:44 -04:00

10 KiB

Raw Permalink Blame History

🤝 为 NOFX 做贡献

语言： English | 中文

感谢您有兴趣为 NOFX 做贡献！本文档提供了为项目做贡献的指南和工作流程。

📑 目录

行为准则
如何贡献
开发工作流程
PR 提交指南
编码规范
提交信息指南
审核流程
悬赏计划

📜 行为准则

本项目遵守行为准则。参与项目即表示您同意遵守此准则。

🎯 如何贡献

1. 报告 Bug 🐛

使用 Bug 报告模板
检查 bug 是否已被报告
包含详细的重现步骤
提供环境信息（操作系统、Go 版本等）

2. 建议功能 ✨

使用功能请求模板
解释使用场景和好处
检查是否与项目路线图一致

3. 提交 Pull Request 🔧

提交 PR 前，请检查以下内容：

✅ 接受的贡献

高优先级（与路线图一致）：

🔒 安全增强（加密、认证、RBAC）
🧠 AI 模型集成（GPT-4、Claude、Gemini Pro）
🔗 交易所集成（OKX、Bybit、Lighter、EdgeX）
📊 交易数据 API（AI500、OI 分析、NetFlow）
🎨 UI/UX 改进（移动端响应式、图表）
⚡ 性能优化
🐛 Bug 修复
📝 文档改进

中等优先级：

✅ 测试覆盖率改进
🌐 国际化（新语言支持）
🔧 构建/部署工具
📈 监控和日志增强

❌ 不接受（未经事先讨论）

没有 RFC（征求意见稿）的重大架构变更
与项目路线图不一致的功能
没有迁移路径的破坏性变更
引入新依赖但没有充分理由的代码
没有可选标志的实验性功能

⚠️ 重要： 对于重大功能，请在开始工作之前先开 issue 讨论。

🛠️ 开发工作流程

1. Fork 和 Clone

# 在 GitHub 上 Fork 仓库
# 然后 clone 你的 fork
git clone https://github.com/YOUR_USERNAME/nofx.git
cd nofx

# 添加 upstream remote
git remote add upstream https://github.com/tinkle-community/nofx.git

2. 创建功能分支

# 更新你的本地 dev 分支
git checkout dev
git pull upstream dev

# 创建新分支
git checkout -b feature/your-feature-name
# 或
git checkout -b fix/your-bug-fix

分支命名规范：

feature/ - 新功能
fix/ - Bug 修复
docs/ - 文档更新
refactor/ - 代码重构
perf/ - 性能改进
test/ - 测试更新
chore/ - 构建/配置更改

3. 设置开发环境

# 安装 Go 依赖
go mod download

# 安装前端依赖
cd web
npm install
cd ..

# 安装 TA-Lib（必需）
# macOS:
brew install ta-lib

# Ubuntu/Debian:
sudo apt-get install libta-lib0-dev

4. 进行更改

遵循编码规范
为新功能编写测试
根据需要更新文档
保持提交专注和原子性

5. 测试你的更改

# 运行后端测试
go test ./...

# 构建后端
go build -o nofx

# 以开发模式运行前端
cd web
npm run dev

# 构建前端
npm run build

6. 提交你的更改

遵循提交信息指南：

git add .
git commit -m "feat: add support for OKX exchange integration"

7. 推送并创建 PR

# 推送到你的 fork
git push origin feature/your-feature-name

# 前往 GitHub 创建 Pull Request
# 使用 PR 模板并填写所有部分

📝 PR 提交指南

提交前检查

代码成功编译（go build 和 npm run build）
所有测试通过（go test ./...）
没有 linting 错误（go fmt、go vet）
文档已更新
提交遵循 conventional commits 格式
分支已基于最新的 dev rebase

PR 标题格式

使用 Conventional Commits 格式：

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

示例：
feat(exchange): add OKX exchange integration
fix(trader): resolve position tracking bug
docs(readme): update installation instructions
perf(ai): optimize prompt generation
refactor(core): extract common exchange interface

类型：

feat - 新功能
fix - Bug 修复
docs - 文档
style - 代码样式（格式化，无逻辑变更）
refactor - 代码重构
perf - 性能改进
test - 测试更新
chore - 构建/配置更改
ci - CI/CD 更改
security - 安全改进

PR 描述

使用 PR 模板并确保：

清晰描述更改内容和原因
变更类型已标记
相关 issue 已链接
测试步骤已记录
UI 更改有截图
所有复选框已完成

PR 大小

保持 PR 专注且大小合理：

✅ 小型 PR（< 300 行）：理想，审核快速
⚠️ 中型 PR（300-1000 行）：可接受，可能需要更长时间
❌ 大型 PR（> 1000 行）：请拆分为更小的 PR

💻 编码规范

Go 代码

// ✅ 好：清晰的命名，正确的错误处理
func ConnectToExchange(apiKey, secret string) (*Exchange, error) {
    if apiKey == "" || secret == "" {
        return nil, fmt.Errorf("API credentials are required")
    }

    client, err := createClient(apiKey, secret)
    if err != nil {
        return nil, fmt.Errorf("failed to create client: %w", err)
    }

    return &Exchange{client: client}, nil
}

// ❌ 差：糟糕的命名，没有错误处理
func ce(a, s string) *Exchange {
    c := createClient(a, s)
    return &Exchange{client: c}
}

最佳实践：

使用有意义的变量名
显式处理所有错误
为复杂逻辑添加注释
遵循 Go 习惯用法和约定
提交前运行 go fmt
使用 go vet 和 golangci-lint

TypeScript/React 代码

// ✅ 好：类型安全，清晰的命名
interface TraderConfig {
  id: string;
  exchange: 'binance' | 'hyperliquid' | 'aster';
  aiModel: string;
  enabled: boolean;
}

const TraderCard: React.FC<{ trader: TraderConfig }> = ({ trader }) => {
  const [isRunning, setIsRunning] = useState(false);

  const handleStart = async () => {
    try {
      await startTrader(trader.id);
      setIsRunning(true);
    } catch (error) {
      console.error('Failed to start trader:', error);
    }
  };

  return <div>...</div>;
};

// ❌ 差：没有类型，不清晰的命名
const TC = (props) => {
  const [r, setR] = useState(false);
  const h = () => { startTrader(props.t.id); setR(true); };
  return <div>...</div>;
};