🤝 Contributing
Thank you for your interest in contributing! This guide will help you get started.
📜 Code of Conduct
Please read our Code of Conduct before contributing.
🚀 Quick Start
- Fork the repository
- Clone your fork locally
- Create a feature branch (
git checkout -b feature/your-feature) - Commit your changes (
git commit -m 'feat: add your feature') - Push to your branch (
git push origin feature/your-feature) - Open a Pull Request
📝 Commit Guidelines
We use Conventional Commits:
<type>: <description>
[optional body]
Types
| Type | Description |
|---|---|
feat | New feature |
fix | Bug fix |
docs | Documentation changes |
style | Code style changes (formatting, etc.) |
refactor | Code refactoring |
test | Adding or updating tests |
chore | Maintenance tasks |
Examples
feat: add user authentication
fix: resolve login timeout issue
docs: update API documentation
🌿 Branch Naming
feature/description- New featuresfix/description- Bug fixesdocs/description- Documentation updates
🔄 Pull Request Process
Before Submitting
- Code follows project style guidelines
- Self-review completed
- Documentation updated if needed
- Tests added/updated (if applicable)
PR Requirements
- Clear title using conventional commit format
- Description of what changed and why
- Issue reference if applicable (
Fixes #123) - Screenshots for UI changes
🐛 Reporting Issues
Use our issue templates:
- 🐛 Bug Report - Something isn't working
- ✨ Feature Request - Suggest an improvement
- 📚 Documentation - Report docs issues
- ❓ Question - Ask a question
🏷️ Labels
| Label | Description |
|---|---|
bug | Something isn't working |
enhancement | New feature request |
documentation | Documentation improvements |
good first issue | Good for newcomers |
help wanted | Extra attention needed |
💬 Getting Help
- Check existing issues
- Start a discussion
- Read the documentation
Thank you for contributing! 🎉