diff --git a/.github/ISSUE_TEMPLATE/README.md b/.github/ISSUE_TEMPLATE/README.md new file mode 100644 index 000000000..a3971f4a6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/README.md @@ -0,0 +1,70 @@ +# 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! 🎉 + diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..1ec3dce65 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,59 @@ +--- +name: Bug Report +about: Report a bug or unexpected behavior in SurfSense +title: '[BUG] ' +labels: bug +assignees: '' +--- + +## Bug Description + + +## Deployment Type + +- [ ] SurfSense Cloud (hosted version) +- [ ] Self-hosted version + +## Steps to Reproduce + +1. Go to '...' +2. Click on '...' +3. Scroll down to '...' +4. See error + +## Expected Behavior + + +## Actual Behavior + + +## Screenshots/Videos + + +## Environment Information + +- **Browser:** [e.g., Chrome 120, Firefox 121, Safari 17] +- **Operating System:** [e.g., Windows 11, macOS 14, Ubuntu 22.04] +- **SurfSense Version:** [e.g., v1.0.0 or commit hash if self-hosted] + +### Additional Environment Details (for Self-hosted only) + +- **Python Version:** [e.g., 3.11] +- **Node.js Version:** [e.g., 20.10.0] +- **Database:** [e.g., PostgreSQL 15] +- **Deployment Method:** [e.g., Docker, Manual installation] + +## Additional Context + + +## Logs/Error Messages + +``` +Paste logs here +``` + +## Checklist +- [ ] I have searched existing issues to ensure this is not a duplicate +- [ ] I have provided all the required information above +- [ ] I have added appropriate labels (bug, deployment type) + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..aff2f79ad --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,12 @@ +blank_issues_enabled: true +contact_links: + - name: 📚 Documentation + url: https://github.com/SurfSense/SurfSense/tree/main/docs + about: Check our documentation for guides and setup instructions + - name: 💬 Discussions + url: https://github.com/SurfSense/SurfSense/discussions + about: Ask questions and discuss ideas with the community + - name: 🤝 Contributing Guide + url: https://github.com/SurfSense/SurfSense/blob/main/CONTRIBUTING.md + about: Learn how to contribute to SurfSense + diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 000000000..723d7a17e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,41 @@ +--- +name: Documentation Issue +about: Report issues or suggest improvements for documentation +title: '[DOCS] ' +labels: documentation +assignees: '' +--- + +## Documentation Issue + + +## Location + +- **File/Page:** [e.g., README.md, docs/setup.md] +- **Section:** [e.g., Installation, Configuration] +- **URL:** [if applicable] + +## Issue Type + +- [ ] Outdated information +- [ ] Missing information +- [ ] Incorrect information +- [ ] Typo/Grammar +- [ ] Unclear explanation +- [ ] Missing example +- [ ] Other (specify below) + +## Current State + + +## Suggested Improvement + + +## Additional Context + + +## Checklist +- [ ] I have checked that this documentation issue doesn't already exist +- [ ] I have provided clear location information +- [ ] I have added appropriate labels (documentation) + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..699df1649 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,52 @@ +--- +name: Feature Request +about: Suggest a new feature or enhancement for SurfSense +title: '[FEATURE] ' +labels: enhancement +assignees: '' +--- + +## Feature Description + + +## Target Deployment + +- [ ] SurfSense Cloud (hosted version) +- [ ] Self-hosted version +- [ ] Both + +## Problem Statement + + + +## Proposed Solution + + +## Alternative Solutions + + +## Benefits + +- +- + +## Use Case Examples + +1. +2. + +## Additional Context + + +## Implementation Considerations + +- [ ] This may require frontend changes +- [ ] This may require backend changes +- [ ] This may require database changes +- [ ] This may affect existing features + +## Checklist +- [ ] I have searched existing issues/feature requests to ensure this is not a duplicate +- [ ] I have provided a clear description of the feature +- [ ] I have added appropriate labels (enhancement, deployment type) +