Back to Nofx

πŸ“š Maintainer Documentation

docs/maintainers/README.md

latest1.6 KB
Original Source

πŸ“š Maintainer Documentation

Language: English | δΈ­ζ–‡

This directory contains documentation for NOFX project maintainers and contributors who want to understand our processes.


πŸ“– Documentation

DocumentDescription
PR_REVIEW_GUIDE.mdGuide for reviewing pull requests
PROJECT_MANAGEMENT.mdProject management workflow and processes
SETUP_GUIDE.mdSetup 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?


Remember: We're building an open, welcoming community. Documentation should empower contributors while maintaining project quality. πŸš€