# Issue Templates Guide

Thank you for contributing to SurfSense! To help us address your issue efficiently, please follow these guidelines:

## 📝 Choosing the Right Template

- **🐛 Bug Report**: Use this when you encounter unexpected behavior, errors, or crashes
- **✨ Feature Request**: Use this to suggest new features or enhancements
- **📚 Documentation Issue**: Use this to report problems with documentation

## 🏷️ Required Labels/Tags

When creating an issue, please add appropriate labels:

### Deployment Type (Required)
Always specify where you encountered the issue:
- `cloud` - For issues on SurfSense Cloud (hosted version)
- `self-hosted` - For issues on self-hosted installations

### Priority (Optional but Recommended)
- `critical` - System crashes, data loss, security issues
- `high` - Major functionality broken
- `medium` - Feature partially works or has workarounds
- `low` - Minor issues, cosmetic problems

### Component (Optional)
Help us route your issue faster:
- `backend` - Python/FastAPI backend issues
- `frontend` - Web interface issues
- `extension` - Browser extension issues
- `database` - Database-related issues
- `api` - API endpoint issues
- `ui/ux` - User interface/experience issues

## ✅ Before Creating an Issue

1. **Search existing issues** - Your issue might already be reported
2. **Check documentation** - The answer might be in our docs
3. **Provide complete information** - Fill out all required fields in the template
4. **Be specific** - Include version numbers, error messages, and reproduction steps

## 💡 Tips for Quality Issues

### For Bug Reports
- Include screenshots or videos when possible
- Provide complete error messages and logs
- Specify exact steps to reproduce
- Include environment details (browser, OS, versions)

### For Feature Requests
- Explain the use case and benefits
- Describe the problem it solves
- Consider implementation challenges

## 🚀 Self-Hosted Users

If you're using a self-hosted version, please include:
- Installation method (Docker, manual, etc.)
- Python and Node.js versions
- Database type and version
- Any custom configuration

## 📞 Need Help?

- **Questions?** Use [GitHub Discussions](https://github.com/SurfSense/SurfSense/discussions)
- **Security Issues?** Please report privately to the maintainers
- **General Chat?** Join our community channels

Thank you for helping make SurfSense better! 🎉

