wehub-resource-sync
6ede33ccdb
Build and Push Docker Images / create_manifest (web, surfsense-web, , cpu) (push) Has been cancelled
Build and Push Docker Images / finalize_release (push) Has been cancelled
Obsidian Plugin Lint / lint (push) Has been cancelled
Build and Push Docker Images / build (./surfsense_web, cpu, ./surfsense_web/Dockerfile, web, surfsense-web, ubuntu-24.04-arm, linux/arm64, arm64, , runner, false, cpu) (push) Has been cancelled
Build and Push Docker Images / build (./surfsense_web, cpu, ./surfsense_web/Dockerfile, web, surfsense-web, ubuntu-latest, linux/amd64, amd64, , runner, false, cpu) (push) Has been cancelled
Build and Push Docker Images / compute_version (push) Has been cancelled
Build and Push Docker Images / build (./surfsense_backend, cpu, ./surfsense_backend/Dockerfile, backend, surfsense-backend, ubuntu-24.04-arm, linux/arm64, arm64, , production, false, cpu) (push) Has been cancelled
Build and Push Docker Images / build (./surfsense_backend, cpu, ./surfsense_backend/Dockerfile, backend, surfsense-backend, ubuntu-latest, linux/amd64, amd64, , production, false, cpu) (push) Has been cancelled
Build and Push Docker Images / build (./surfsense_backend, cu126, ./surfsense_backend/Dockerfile, backend, surfsense-backend, ubuntu-24.04-arm, linux/arm64, arm64, -cuda126, production, true, cuda126) (push) Has been cancelled
Build and Push Docker Images / build (./surfsense_backend, cu126, ./surfsense_backend/Dockerfile, backend, surfsense-backend, ubuntu-latest, linux/amd64, amd64, -cuda126, production, true, cuda126) (push) Has been cancelled
Build and Push Docker Images / build (./surfsense_backend, cu128, ./surfsense_backend/Dockerfile, backend, surfsense-backend, ubuntu-24.04-arm, linux/arm64, arm64, -cuda, production, true, cuda) (push) Has been cancelled
Build and Push Docker Images / build (./surfsense_backend, cu128, ./surfsense_backend/Dockerfile, backend, surfsense-backend, ubuntu-latest, linux/amd64, amd64, -cuda, production, true, cuda) (push) Has been cancelled
Build and Push Docker Images / verify_digests (push) Has been cancelled
Build and Push Docker Images / create_manifest (backend, surfsense-backend, , cpu) (push) Has been cancelled
Build and Push Docker Images / create_manifest (backend, surfsense-backend, -cuda, cuda) (push) Has been cancelled
Build and Push Docker Images / create_manifest (backend, surfsense-backend, -cuda126, cuda126) (push) Has been cancelled
71 lines
2.4 KiB
Markdown
71 lines
2.4 KiB
Markdown
# 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! 🎉
|
|
|