Files
nofx/.github/ISSUE_TEMPLATE/bug_report.md
Liu Xiang Qian b27bad4d74 docs: Enhance bug report template and add comprehensive troubleshooting guide
- Enhanced bug report template with detailed log capture instructions
  - Added bug categorization system (6 main categories)
  - Frontend error capture guide (DevTools Console/Network tabs)
  - Backend log capture for Docker and PM2 deployments
  - Trading/decision logs location and usage
  - Comprehensive environment information checklist
  - Quick diagnostic tips for faster issue resolution

- Created bilingual troubleshooting guides (EN/ZH)
  - Common trading issues (e.g., Issue #202: only short positions)
  - Detailed explanation of Binance position mode requirements
  - AI decision problems and diagnostics
  - Connection and API error solutions
  - Frontend and database issues
  - Complete log capture instructions with commands
  - Emergency reset procedures

- Updated documentation cross-references
  - Added troubleshooting guide links to bug report template
  - Added links in README Common Issues section
  - Bilingual support for better accessibility

This reduces maintainer workload by helping users self-diagnose issues
and submit higher-quality bug reports with all necessary information.

Addresses Issue #202 root cause documentation.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: tinkle-community <tinklefund@gmail.com>
2025-11-02 10:19:19 +08:00

4.6 KiB

name, about, title, labels, assignees
name about title labels assignees
Bug Report Report a bug to help us improve NOFX [BUG] bug

⚠️ Before submitting: Please check the Troubleshooting Guide (中文版) to see if your issue can be resolved quickly.

🐛 Bug Description

🔍 Bug Category

  • Trading execution (orders not executing, wrong position size, etc.)
  • AI decision issues (unexpected decisions, only opening one direction, etc.)
  • Exchange connection (API errors, authentication failures, etc.)
  • UI/Frontend (display issues, buttons not working, data not updating, etc.)
  • Backend/API (server errors, crashes, performance issues, etc.)
  • Configuration (settings not saving, database errors, etc.)
  • Other: _________________

📋 Steps to Reproduce

  1. Go to '...'
  2. Click on '...' / Run command '...'
  3. Configure '...'
  4. See error

Expected Behavior

Actual Behavior

📸 Screenshots & Logs

Frontend Error (if applicable)

Browser Console Screenshot:

Network Tab (failed requests):

Backend Logs (if applicable)

Docker users:

# View backend logs
docker compose logs backend --tail=100

# OR continuously follow logs
docker compose logs -f backend

Manual/PM2 users:

# Terminal output where you ran: ./nofx
# OR PM2 logs:
pm2 logs nofx --lines 100

Backend Log Output:

Paste backend logs here (last 50-100 lines around the error)

Trading/Decision Logs (if trading issue)

Decision Log Path: decision_logs/{trader_id}/{timestamp}.json

{
  "paste relevant decision log here if applicable"
}

💻 Environment

System:

  • OS: [e.g. macOS 13, Ubuntu 22.04, Windows 11]
  • Deployment: [Docker / Manual / PM2]

Backend:

  • Go Version: [run: go version]
  • NOFX Version: [run: git log -1 --oneline or check release tag]

Frontend:

  • Browser: [e.g. Chrome 120, Firefox 121, Safari 17]
  • Node.js Version: [run: node -v]

Trading Setup:

  • Exchange: [Binance / Hyperliquid / Aster]
  • Account Type: [Main Account / Subaccount]
  • Position Mode: [Hedge Mode (Dual) / One-way Mode] ← Important for trading bugs!
  • AI Model: [DeepSeek / Qwen / Custom]
  • Number of Traders: [e.g. 1, 2, etc.]

🔧 Configuration (if relevant)

Leverage Settings:

{
  "btc_eth_leverage": 5,
  "altcoin_leverage": 5
}

Any custom settings:

📊 Additional Context

Frequency:

  • Happens every time
  • Happens randomly
  • Happened once

Timeline:

  • Did this work before? [ ] Yes [ ] No
  • When did it break? [e.g. after upgrade to v3.0.0, after changing config, etc.]
  • Recent changes? [e.g. updated dependencies, changed exchange, etc.]

Impact:

  • System cannot start
  • Trading stopped/broken
  • UI broken but trading works
  • Minor visual issue
  • Other: _________________

💡 Possible Solution


📝 Quick Tips for Faster Resolution

For Trading Issues:

  1. Check Binance position mode: Go to Futures → ⚙️ Preferences → Position Mode → Must be Hedge Mode
  2. Verify API permissions: Futures trading must be enabled
  3. Check decision logs in decision_logs/{trader_id}/ for AI reasoning

For Connection Issues: 4. Test API connectivity: curl http://localhost:8080/api/health 5. Check API rate limits on exchange 6. Verify API keys are not expired

For UI Issues: 7. Hard refresh: Ctrl+Shift+R (or Cmd+Shift+R on Mac) 8. Check browser console (F12) for errors 9. Verify backend is running: docker compose ps or ps aux | grep nofx