Commit Graph

4 Commits

Author SHA1 Message Date
Liu Xiang Qian
03d709de8e 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: Claude <noreply@anthropic.com>
2025-11-02 10:19:19 +08:00
zbhan
9a604f9b27 feat: pr validation 2025-11-01 18:25:44 -04:00
zbhan
18820fc319 Feat: Update docs
- 重构文档结构
- 更新文档内容
- 制定roadmap
- 提供中/EN 双语文档
2025-11-01 15:05:24 -04:00
tinkle
81475eb88e Docs: Add bounty templates for Hyperliquid and Aster exchange integration
Add comprehensive bounty documentation to recruit contributors for
exchange integrations:

**New Files:**
- `.github/ISSUE_TEMPLATE/feature_request.md` - GitHub Issue template
- `INTEGRATION_BOUNTY_HYPERLIQUID.md` - Complete Hyperliquid integration spec
- `INTEGRATION_BOUNTY_ASTER.md` - Complete Aster integration spec
- `HOW_TO_POST_BOUNTY.md` - Step-by-step guide for posting bounties

**Bounty Documentation Includes:**
- Clear task requirements and acceptance criteria
- Technical specifications and interface definitions
- File structure and implementation guidelines
- Testing and documentation requirements
- Contribution workflow
- Support resources and community links

**HOW_TO_POST_BOUNTY.md Guide:**
- Two methods to post GitHub Issues (Web UI + GitHub CLI)
- Bounty platform recommendations (Gitcoin, Bountysource, IssueHunt)
- Social media promotion templates (Twitter, Telegram, Reddit)
- Issue management best practices
- Legal and quality control considerations

**Benefits:**
- Standardized contribution process
- Clear technical requirements
- Professional bounty presentation
- Easy for maintainers to post and manage
- Attractive for potential contributors

Ready to recruit developers for multi-exchange support! 🚀

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

Co-Authored-By: Claude <noreply@anthropic.com>
2025-10-29 19:47:20 +08:00