mirror of
https://github.com/NoFxAiOS/nofx.git
synced 2026-06-06 05:51:19 +08:00
52 lines
1.6 KiB
Markdown
52 lines
1.6 KiB
Markdown
# 📚 Maintainer Documentation
|
|
|
|
**Language:** [English](README.md) | [中文](README.zh-CN.md)
|
|
|
|
This directory contains documentation for NOFX project maintainers and contributors who want to understand our processes.
|
|
|
|
---
|
|
|
|
## 📖 Documentation
|
|
|
|
| Document | Description |
|
|
|----------|-------------|
|
|
| [PR_REVIEW_GUIDE.md](PR_REVIEW_GUIDE.md) | Guide for reviewing pull requests |
|
|
| [PROJECT_MANAGEMENT.md](PROJECT_MANAGEMENT.md) | Project management workflow and processes |
|
|
| [SETUP_GUIDE.md](SETUP_GUIDE.md) | Setup guide for the PR management system |
|
|
|
|
**Available in:** 🇬🇧 English | 🇨🇳 中文
|
|
|
|
---
|
|
|
|
## 🎯 For New Maintainers
|
|
|
|
If you're a new maintainer, start here:
|
|
|
|
1. **Read the documentation** (listed above) to understand the review process
|
|
2. **Shadow an experienced maintainer** for 1-2 weeks
|
|
3. **Start with simple reviews** before handling complex PRs
|
|
4. **Ask questions** in the maintainer channel
|
|
|
|
---
|
|
|
|
## 🤝 For Contributors
|
|
|
|
These documents are also helpful for contributors who want to:
|
|
- Understand our review standards
|
|
- Learn our project management workflow
|
|
- See how we prioritize work
|
|
|
|
Everything here is transparent and designed to help you contribute successfully!
|
|
|
|
---
|
|
|
|
## 📞 Questions?
|
|
|
|
- **Public questions:** Use [GitHub Discussions](https://github.com/NoFxAiOS/nofx/discussions)
|
|
- **Maintainer questions:** Use the maintainer channel
|
|
- **Migration questions:** See [Migration Announcement](../community/MIGRATION_ANNOUNCEMENT.md)
|
|
|
|
---
|
|
|
|
**Remember:** We're building an open, welcoming community. Documentation should empower contributors while maintaining project quality. 🚀
|