Skip to content

Conversation

@zk-quantum
Copy link

@zk-quantum zk-quantum commented Aug 4, 2025

Description

This PR establishes essential community infrastructure for the Qwen3-Coder project. As an open-source project with growing community interest (36 open issues, active development), having proper contribution guidelines and developer documentation is crucial for sustainable growth.

Motivation

Currently, Qwen3-Coder lacks:

  • Formal contribution guidelines
  • Code of conduct
  • Issue/PR templates
  • Comprehensive developer documentation

This makes it challenging for new contributors to get started and can lead to inconsistent contributions.

Changes Made

📚 Documentation

  • CONTRIBUTING.md: Comprehensive contribution guidelines including:

    • Getting started instructions
    • Development workflow
    • Code style guidelines
    • Testing requirements
    • PR process
  • CODE_OF_CONDUCT.md: Based on Contributor Covenant 2.1, establishing community standards

  • DEVELOPER_GUIDE.md: In-depth guide covering:

    • Hardware requirements for different model sizes
    • Environment setup (conda, CUDA, multi-GPU)
    • Model loading strategies and memory optimization
    • Development workflow and testing
    • Performance optimization techniques
    • Common issues and solutions
    • Advanced topics (fine-tuning, tool integration)
  • requirements-dev.txt: Development dependencies for consistent dev environment

🎯 GitHub Templates

  • Bug Report Template: Structured format for reporting issues
  • Feature Request Template: Clear format for proposing enhancements
  • Question Template: For community Q&A
  • Pull Request Template: Comprehensive PR checklist
  • Issue Config: Links to Discord, docs, and blog

Benefits

  1. Lower Barrier to Entry: Clear guidelines help new contributors get started quickly
  2. Consistent Contributions: Templates ensure quality and completeness
  3. Community Standards: Code of conduct fosters inclusive environment
  4. Better Issue Management: Structured templates improve issue quality
  5. Knowledge Sharing: Developer guide captures best practices for working with large models

Special Considerations

The developer guide specifically addresses challenges unique to Qwen3-Coder:

  • Working with 480B parameter models
  • Multi-GPU setup and memory management
  • FP8 quantization usage
  • Long-context handling (256K-1M tokens)

Testing

All markdown files have been validated for:

  • Proper formatting
  • Working links (where applicable)
  • Clear structure and readability

Related Issues

This addresses the general need for better project documentation and community guidelines, though no specific issue was opened for this.

Next Steps

If this PR is accepted, potential follow-ups could include:

  • GitHub Actions for automated testing
  • Documentation website (using mkdocs or similar)
  • Contribution recognition system
  • More detailed evaluation guides

Thank you for considering this contribution! I'm happy to make any adjustments based on feedback.

…ntation

This commit establishes essential community infrastructure for the Qwen3-Coder project:

Documentation:
- Added CONTRIBUTING.md with detailed contribution guidelines
- Added CODE_OF_CONDUCT.md based on Contributor Covenant 2.1
- Added DEVELOPER_GUIDE.md with comprehensive setup and usage instructions
- Added requirements-dev.txt for development dependencies

GitHub Templates:
- Added bug report issue template
- Added feature request issue template
- Added question issue template
- Added issue template configuration
- Added pull request template

These additions will help:
- Onboard new contributors more effectively
- Establish community standards and expectations
- Provide clear guidance for development setup
- Streamline issue reporting and PR processes
- Foster a welcoming and inclusive community

The developer guide includes specific guidance for working with large language models,
including hardware requirements, multi-GPU setup, memory optimization, and common issues.

🤖 Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
Copy link
Collaborator

@cyente cyente left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for your contribution

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants