CONTRIBUTING.md

Contributing Guide

Thank you for considering contributing to Youtu-RAG! We welcome all forms of contributions.

Quick Start

# 1. Fork and clone the repository
git clone https://github.com/YOUR_USERNAME/youtu-rag.git
cd youtu-rag

# 2. Install dependencies
uv sync

Development Guidelines

Commit Convention

Follow Conventional Commits:

• feat: New feature
• fix: Bug fix
• docs: Documentation update
• refactor: Code refactoring
• test: Test related
• chore: Build/tooling related

Submitting Pull Requests

1. Create a new branch: git checkout -b feature/your-feature
2. Develop and pass tests
3. Commit your code: git commit -m "feat: feature description"
4. Push the branch: git push origin feature/your-feature
5. Create a Pull Request on GitHub

PR Requirements

• Link to related Issue
• Keep changes small and focused
• Update relevant documentation
• Ensure all checks pass
• Provide clear PR description

Reporting Issues

When submitting issues on GitHub Issues, please provide:

• Environment info (Python version, OS)
• Steps to reproduce
• Expected vs actual behavior
• Error logs

Thank you for your contribution! 🎉