mirror of
https://github.com/NoFxAiOS/nofx.git
synced 2026-07-10 06:20:58 +08:00
Feat: Update docs
- 重构文档结构 - 更新文档内容 - 制定roadmap - 提供中/EN 双语文档
This commit is contained in:
93
.github/ISSUE_TEMPLATE/bounty_claim.md
vendored
Normal file
93
.github/ISSUE_TEMPLATE/bounty_claim.md
vendored
Normal file
@@ -0,0 +1,93 @@
|
||||
---
|
||||
name: Bounty Claim
|
||||
about: Claim a bounty task or propose a new bounty
|
||||
title: '[BOUNTY CLAIM] '
|
||||
labels: bounty
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## 💰 Bounty Information
|
||||
|
||||
**Claiming existing bounty?**
|
||||
- Issue #: <!-- Link to existing bounty issue -->
|
||||
- Bounty amount: <!-- If specified -->
|
||||
|
||||
**OR proposing new bounty?**
|
||||
- Proposed feature/fix: <!-- Brief description -->
|
||||
- Estimated effort: [Small / Medium / Large]
|
||||
|
||||
---
|
||||
|
||||
## 👤 About You
|
||||
|
||||
**Name/Username:** <!-- Your name or GitHub username -->
|
||||
|
||||
**Contact:**
|
||||
- GitHub: @your_username
|
||||
- Telegram: @your_telegram (optional)
|
||||
- Email: your@email.com (optional)
|
||||
|
||||
**Relevant Experience:**
|
||||
- <!-- Link to your GitHub profile -->
|
||||
- <!-- Previous contributions or similar projects -->
|
||||
- <!-- Relevant skills (Go, React, trading systems, etc.) -->
|
||||
|
||||
---
|
||||
|
||||
## 📋 Implementation Plan
|
||||
|
||||
### 1. Approach
|
||||
<!-- Describe your technical approach -->
|
||||
- How will you implement this?
|
||||
- What components will be affected?
|
||||
- Any dependencies or libraries needed?
|
||||
|
||||
### 2. Timeline
|
||||
- **Start date:** <!-- When you plan to start -->
|
||||
- **Estimated completion:** <!-- How long will it take? -->
|
||||
- **Milestones:**
|
||||
- [ ] Week 1: ...
|
||||
- [ ] Week 2: ...
|
||||
- [ ] Week 3: ...
|
||||
|
||||
### 3. Deliverables
|
||||
- [ ] Working code (merged PR)
|
||||
- [ ] Unit tests (if applicable)
|
||||
- [ ] Documentation updates
|
||||
- [ ] Demo video/screenshots
|
||||
|
||||
---
|
||||
|
||||
## 🔍 Questions for Maintainers
|
||||
|
||||
<!-- Any questions you have about the requirements? -->
|
||||
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
---
|
||||
|
||||
## 📚 References
|
||||
|
||||
<!-- Any relevant links, documentation, or examples -->
|
||||
|
||||
-
|
||||
|
||||
---
|
||||
|
||||
## ✅ Acknowledgment
|
||||
|
||||
By claiming this bounty, I acknowledge that:
|
||||
- [ ] I have read the [Contributing Guide](../../CONTRIBUTING.md)
|
||||
- [ ] I will follow the [Code of Conduct](../../CODE_OF_CONDUCT.md)
|
||||
- [ ] I understand the acceptance criteria
|
||||
- [ ] My contribution will be licensed under MIT License
|
||||
- [ ] Payment is subject to successful PR merge
|
||||
|
||||
---
|
||||
|
||||
**For maintainers:**
|
||||
- [ ] Bounty claim approved
|
||||
- [ ] Issue assigned to claimant
|
||||
- [ ] Timeline agreed upon
|
||||
47
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
47
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@@ -0,0 +1,47 @@
|
||||
---
|
||||
name: Bug Report
|
||||
about: Report a bug to help us improve NOFX
|
||||
title: '[BUG] '
|
||||
labels: bug
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## 🐛 Bug Description
|
||||
<!-- A clear and concise description of what the bug is -->
|
||||
|
||||
## 📋 Steps to Reproduce
|
||||
1. Go to '...'
|
||||
2. Click on '...'
|
||||
3. Run command '...'
|
||||
4. See error
|
||||
|
||||
## ✅ Expected Behavior
|
||||
<!-- What you expected to happen -->
|
||||
|
||||
## ❌ Actual Behavior
|
||||
<!-- What actually happened -->
|
||||
|
||||
## 📸 Screenshots / Logs
|
||||
<!-- If applicable, add screenshots or error logs to help explain your problem -->
|
||||
|
||||
```
|
||||
Paste logs here
|
||||
```
|
||||
|
||||
## 💻 Environment
|
||||
- **OS:** [e.g. macOS 13, Ubuntu 22.04, Windows 11]
|
||||
- **Go Version:** [e.g. 1.21.5]
|
||||
- **Node.js Version:** [e.g. 18.17.0]
|
||||
- **NOFX Version/Commit:** [e.g. v3.0.0 or commit hash]
|
||||
- **Deployment Method:** [Docker / Manual / PM2]
|
||||
- **Exchange:** [Binance / Hyperliquid / Aster]
|
||||
|
||||
## 🔧 Additional Context
|
||||
<!-- Add any other context about the problem here -->
|
||||
|
||||
- Does this happen consistently or intermittently?
|
||||
- Did it work before? When did it break?
|
||||
- Any recent configuration changes?
|
||||
|
||||
## ✋ Possible Solution
|
||||
<!-- Optional: If you have ideas on how to fix this -->
|
||||
Reference in New Issue
Block a user