liuyu/nofx
1
0
Fork 0
mirror of https://github.com/NoFxAiOS/nofx.git synced 2026-06-06 05:51:19 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
b10b9ec1a789d24eed73bbd3fd5f70c905c7328e
nofx/.github/PULL_REQUEST_TEMPLATE/docs.md
SkywalkerJi b10b9ec1a7 docs: convert PR templates to English-only (#1331)
2026-01-12 22:06:17 -06:00

1.6 KiB
Raw Blame History

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)

🌐 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:

🌟 Thank you for your contribution!