mirror of
https://github.com/MODSetter/SurfSense.git
synced 2026-07-10 22:32:16 +02:00
chore: added issue templates
This commit is contained in:
parent
351b38801b
commit
5783aa02f4
5 changed files with 234 additions and 0 deletions
70
.github/ISSUE_TEMPLATE/README.md
vendored
Normal file
70
.github/ISSUE_TEMPLATE/README.md
vendored
Normal file
|
|
@ -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! 🎉
|
||||||
|
|
||||||
59
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
59
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
|
|
@ -0,0 +1,59 @@
|
||||||
|
---
|
||||||
|
name: Bug Report
|
||||||
|
about: Report a bug or unexpected behavior in SurfSense
|
||||||
|
title: '[BUG] '
|
||||||
|
labels: bug
|
||||||
|
assignees: ''
|
||||||
|
---
|
||||||
|
|
||||||
|
## Bug Description
|
||||||
|
<!-- Provide a clear and concise description of the bug -->
|
||||||
|
|
||||||
|
## Deployment Type
|
||||||
|
<!-- Please select where you encountered this issue -->
|
||||||
|
- [ ] SurfSense Cloud (hosted version)
|
||||||
|
- [ ] Self-hosted version
|
||||||
|
|
||||||
|
## Steps to Reproduce
|
||||||
|
<!-- Provide detailed steps to reproduce the behavior -->
|
||||||
|
1. Go to '...'
|
||||||
|
2. Click on '...'
|
||||||
|
3. Scroll down to '...'
|
||||||
|
4. See error
|
||||||
|
|
||||||
|
## Expected Behavior
|
||||||
|
<!-- Describe what you expected to happen -->
|
||||||
|
|
||||||
|
## Actual Behavior
|
||||||
|
<!-- Describe what actually happened -->
|
||||||
|
|
||||||
|
## Screenshots/Videos
|
||||||
|
<!-- If applicable, add screenshots or videos to help explain the problem -->
|
||||||
|
|
||||||
|
## Environment Information
|
||||||
|
<!-- Please complete the following 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)
|
||||||
|
<!-- If you selected self-hosted, please provide: -->
|
||||||
|
- **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
|
||||||
|
<!-- Add any other context about the problem here -->
|
||||||
|
|
||||||
|
## Logs/Error Messages
|
||||||
|
<!-- If applicable, paste relevant logs or 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)
|
||||||
|
|
||||||
12
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
12
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
|
|
@ -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
|
||||||
|
|
||||||
41
.github/ISSUE_TEMPLATE/documentation.md
vendored
Normal file
41
.github/ISSUE_TEMPLATE/documentation.md
vendored
Normal file
|
|
@ -0,0 +1,41 @@
|
||||||
|
---
|
||||||
|
name: Documentation Issue
|
||||||
|
about: Report issues or suggest improvements for documentation
|
||||||
|
title: '[DOCS] '
|
||||||
|
labels: documentation
|
||||||
|
assignees: ''
|
||||||
|
---
|
||||||
|
|
||||||
|
## Documentation Issue
|
||||||
|
<!-- Describe the documentation issue or improvement needed -->
|
||||||
|
|
||||||
|
## Location
|
||||||
|
<!-- Where is the documentation issue? -->
|
||||||
|
- **File/Page:** [e.g., README.md, docs/setup.md]
|
||||||
|
- **Section:** [e.g., Installation, Configuration]
|
||||||
|
- **URL:** [if applicable]
|
||||||
|
|
||||||
|
## Issue Type
|
||||||
|
<!-- Select the type of documentation issue -->
|
||||||
|
- [ ] Outdated information
|
||||||
|
- [ ] Missing information
|
||||||
|
- [ ] Incorrect information
|
||||||
|
- [ ] Typo/Grammar
|
||||||
|
- [ ] Unclear explanation
|
||||||
|
- [ ] Missing example
|
||||||
|
- [ ] Other (specify below)
|
||||||
|
|
||||||
|
## Current State
|
||||||
|
<!-- Describe what the documentation currently says (if applicable) -->
|
||||||
|
|
||||||
|
## Suggested Improvement
|
||||||
|
<!-- Describe what you think should be changed or added -->
|
||||||
|
|
||||||
|
## Additional Context
|
||||||
|
<!-- Add any other context, screenshots, or examples here -->
|
||||||
|
|
||||||
|
## Checklist
|
||||||
|
- [ ] I have checked that this documentation issue doesn't already exist
|
||||||
|
- [ ] I have provided clear location information
|
||||||
|
- [ ] I have added appropriate labels (documentation)
|
||||||
|
|
||||||
52
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
52
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
|
|
@ -0,0 +1,52 @@
|
||||||
|
---
|
||||||
|
name: Feature Request
|
||||||
|
about: Suggest a new feature or enhancement for SurfSense
|
||||||
|
title: '[FEATURE] '
|
||||||
|
labels: enhancement
|
||||||
|
assignees: ''
|
||||||
|
---
|
||||||
|
|
||||||
|
## Feature Description
|
||||||
|
<!-- Provide a clear and concise description of the feature you'd like to see -->
|
||||||
|
|
||||||
|
## Target Deployment
|
||||||
|
<!-- Please select which deployment(s) this feature should apply to -->
|
||||||
|
- [ ] SurfSense Cloud (hosted version)
|
||||||
|
- [ ] Self-hosted version
|
||||||
|
- [ ] Both
|
||||||
|
|
||||||
|
## Problem Statement
|
||||||
|
<!-- Describe the problem or use case this feature would solve -->
|
||||||
|
<!-- Example: "I'm always frustrated when..." -->
|
||||||
|
|
||||||
|
## Proposed Solution
|
||||||
|
<!-- Describe how you envision this feature working -->
|
||||||
|
|
||||||
|
## Alternative Solutions
|
||||||
|
<!-- Describe any alternative solutions or features you've considered -->
|
||||||
|
|
||||||
|
## Benefits
|
||||||
|
<!-- Explain how this feature would benefit SurfSense users -->
|
||||||
|
-
|
||||||
|
-
|
||||||
|
|
||||||
|
## Use Case Examples
|
||||||
|
<!-- Provide concrete examples of how this feature would be used -->
|
||||||
|
1.
|
||||||
|
2.
|
||||||
|
|
||||||
|
## Additional Context
|
||||||
|
<!-- Add any other context, mockups, or screenshots about the feature request here -->
|
||||||
|
|
||||||
|
## Implementation Considerations
|
||||||
|
<!-- Optional: If you have technical insights, share them here -->
|
||||||
|
- [ ] 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)
|
||||||
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue