mirror of
https://github.com/laoxong/nofx.git
synced 2026-06-07 11:17:56 +08:00
SkywalkerJi
92 lines
1.6 KiB
Markdown
92 lines
1.6 KiB
Markdown
# Pull Request - Documentation
|
|
|
|
> **💡 Tip:** Recommended PR title format `docs(scope): description`
|
|
> Example: `docs(api): update trading endpoints` | `docs(readme): add setup guide`
|
|
|
|
---
|
|
|
|
## 📝 Description
|
|
|
|
|
|
---
|
|
|
|
## 📚 Type of Documentation
|
|
|
|
- [ ] 📖 README update
|
|
- [ ] 📋 API documentation
|
|
- [ ] 🎓 Tutorial/Guide
|
|
- [ ] 📝 Code comments
|
|
- [ ] 🔧 Configuration docs
|
|
- [ ] 🐛 Fix typo/error
|
|
- [ ] 🌍 Translation
|
|
|
|
---
|
|
|
|
## 🔗 Related Issues
|
|
|
|
- Closes #
|
|
- Related to #
|
|
|
|
---
|
|
|
|
## 📋 Changes Made
|
|
|
|
-
|
|
-
|
|
|
|
---
|
|
|
|
## 📸 Screenshots (if applicable)
|
|
|
|
<!-- For documentation with images, diagrams, or UI examples -->
|
|
|
|
|
|
---
|
|
|
|
## 🌐 Internationalization
|
|
|
|
- [ ] English version complete
|
|
- [ ] Chinese version complete
|
|
- [ ] Both versions are consistent
|
|
- [ ] N/A (only one language needed)
|
|
|
|
---
|
|
|
|
## ✅ Checklist
|
|
|
|
### Content Quality
|
|
- [ ] Information is accurate and up-to-date
|
|
- [ ] Language is clear and concise
|
|
- [ ] No spelling or grammar errors
|
|
- [ ] Links are valid and working
|
|
- [ ] Code examples are tested and working
|
|
- [ ] Formatting is consistent
|
|
|
|
### Documentation Standards
|
|
- [ ] Follows project documentation style
|
|
- [ ] Includes necessary examples
|
|
- [ ] Technical terms are explained
|
|
- [ ] Self-review completed
|
|
|
|
### Git
|
|
- [ ] Commits follow conventional format
|
|
- [ ] Rebased on latest `dev` branch
|
|
- [ ] No merge conflicts
|
|
|
|
---
|
|
|
|
## 📚 Additional Notes
|
|
|
|
|
|
---
|
|
|
|
**By submitting this PR, I confirm:**
|
|
|
|
- [ ] I have read the [Contributing Guidelines](../../CONTRIBUTING.md)
|
|
- [ ] I agree to the [Code of Conduct](../../CODE_OF_CONDUCT.md)
|
|
- [ ] My contribution is licensed under AGPL-3.0
|
|
|
|
---
|
|
|
|
🌟 **Thank you for your contribution!**
|