Make Contribution

We hope DeepTutor could become a gift for the community. 🎁

Join Our Community

💬 WeChat Community 🤝 WeChat Co-creators 🌐 Discord

We Welcome Contributions!

Whether you're fixing bugs, improving documentation, or adding new features, your contributions are valuable to us.

How to Contribute

1. Report Bugs — Found a bug? Open an issue on GitHub with reproduction steps
2. Suggest Features — Share ideas in GitHub Discussions or our community channels
3. Improve Docs — Help us improve documentation, tutorials, and examples
4. Submit Code — Fix bugs or implement new features through pull requests

Contribution Guidelines

For detailed guidelines, see CONTRIBUTING.md.

Key Points:

• All contributions must be based on the dev branch
• Run pre-commit run --all-files before submitting
• Use conventional commit format: feat:, fix:, docs:, etc.

Quick Start

# Fork and clone
git clone https://github.com/YOUR_USERNAME/DeepTutor.git
cd DeepTutor

# Create feature branch from dev
git checkout dev && git pull origin dev
git checkout -b feature/your-feature-name

# Install pre-commit hooks
pip install pre-commit && pre-commit install

# Make changes, then submit PR to dev branch

Our Contributors

---

Thank you for your interest in contributing to DeepTutor! 🚀