mirror of
https://github.com/lfnovo/open-notebook.git
synced 2026-04-30 20:39:55 +00:00
chore: issue templates
This commit is contained in:
parent
2b9ef266b4
commit
fc4d73c9e8
4 changed files with 281 additions and 0 deletions
85
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
85
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
|
|
@ -0,0 +1,85 @@
|
|||
name: 🐛 Bug Report
|
||||
description: Report a bug or unexpected behavior (app is running but misbehaving)
|
||||
title: "[Bug]: "
|
||||
labels: ["bug", "needs-triage"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for reporting a bug! Please fill out the information below to help us understand and fix the issue.
|
||||
|
||||
**Note**: If you're having installation or setup issues, please use the "Installation Issue" template instead.
|
||||
|
||||
- type: textarea
|
||||
id: what-happened
|
||||
attributes:
|
||||
label: What did you do when it broke?
|
||||
description: Describe the steps you took that led to the bug
|
||||
placeholder: |
|
||||
1. I went to the Notebooks page
|
||||
2. I clicked on "Create New Notebook"
|
||||
3. I filled in the form and clicked "Save"
|
||||
4. Then the error occurred...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: how-broke
|
||||
attributes:
|
||||
label: How did it break?
|
||||
description: What happened that was unexpected? What did you expect to happen instead?
|
||||
placeholder: |
|
||||
Expected: The notebook should be created and I should see it in the list
|
||||
Actual: I got an error message saying "Failed to create notebook"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: logs-screenshots
|
||||
attributes:
|
||||
label: Logs or Screenshots
|
||||
description: |
|
||||
Please provide any error messages, logs, or screenshots that might help us understand the issue.
|
||||
|
||||
**How to get logs:**
|
||||
- Docker: `docker compose logs -f open_notebook`
|
||||
- Check browser console (F12 → Console tab)
|
||||
placeholder: |
|
||||
Paste logs here or drag and drop screenshots.
|
||||
|
||||
Error messages, stack traces, or browser console errors are very helpful!
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: dropdown
|
||||
id: version
|
||||
attributes:
|
||||
label: Open Notebook Version
|
||||
description: Which version are you using?
|
||||
options:
|
||||
- v1-latest (Docker)
|
||||
- v1-latest-single (Docker)
|
||||
- Latest from main branch
|
||||
- Other (please specify in additional context)
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: environment
|
||||
attributes:
|
||||
label: Environment
|
||||
description: What environment are you running in?
|
||||
placeholder: |
|
||||
- OS: Ubuntu 22.04 / Windows 11 / macOS 14
|
||||
- Browser: Chrome 120
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: additional-context
|
||||
attributes:
|
||||
label: Additional Context
|
||||
description: Any other information that might be helpful
|
||||
placeholder: "This started happening after I upgraded to v1.5.0..."
|
||||
validations:
|
||||
required: false
|
||||
11
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
11
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: 💬 Discord Community
|
||||
url: https://discord.gg/37XJPXfz2w
|
||||
about: Get help from the community and share ideas
|
||||
- name: 🤖 Installation Assistant (ChatGPT)
|
||||
url: https://chatgpt.com/g/g-68776e2765b48191bd1bae3f30212631-open-notebook-installation-assistant
|
||||
about: AI-powered installation help - try this first for setup issues!
|
||||
- name: 📚 Documentation
|
||||
url: https://github.com/lfnovo/open-notebook/tree/main/docs
|
||||
about: Browse our comprehensive documentation
|
||||
37
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
37
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
|
|
@ -0,0 +1,37 @@
|
|||
name: ✨ Feature Suggestion
|
||||
description: Suggest a new feature or improvement for Open Notebook
|
||||
title: "[Feature]: "
|
||||
labels: ["enhancement", "needs-triage"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to suggest a feature! Your ideas help make Open Notebook better for everyone.
|
||||
|
||||
- type: textarea
|
||||
id: feature-description
|
||||
attributes:
|
||||
label: Feature Description
|
||||
description: What feature would you like to see added or improved?
|
||||
placeholder: "I would like to be able to..."
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: why-helpful
|
||||
attributes:
|
||||
label: Why would this be helpful?
|
||||
description: Explain how this feature would benefit you and other users
|
||||
placeholder: "This would help because..."
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: additional-context
|
||||
attributes:
|
||||
label: Additional Context
|
||||
description: Any other context, screenshots, or examples that might be helpful
|
||||
placeholder: "For example, other tools do this by..."
|
||||
validations:
|
||||
required: false
|
||||
|
||||
148
.github/ISSUE_TEMPLATE/installation_issue.yml
vendored
Normal file
148
.github/ISSUE_TEMPLATE/installation_issue.yml
vendored
Normal file
|
|
@ -0,0 +1,148 @@
|
|||
name: 🔧 Installation Issue
|
||||
description: Report problems with installation, setup, or connectivity
|
||||
title: "[Install]: "
|
||||
labels: ["installation", "needs-triage"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
## ⚠️ Before You Continue
|
||||
|
||||
**Please try these resources first:**
|
||||
|
||||
1. 🤖 **[Installation Assistant ChatGPT](https://chatgpt.com/g/g-68776e2765b48191bd1bae3f30212631-open-notebook-installation-assistant)** - Our AI assistant can help you troubleshoot most installation issues instantly!
|
||||
|
||||
2. 📚 **[Installation Guide](https://github.com/lfnovo/open-notebook/blob/main/docs/getting-started/installation.md)** - Comprehensive setup instructions
|
||||
|
||||
3. 🐋 **[Docker Deployment Guide](https://github.com/lfnovo/open-notebook/blob/main/docs/deployment/docker.md)** - Detailed Docker setup
|
||||
|
||||
4. 🦙 **Ollama Issues?** Read our [Ollama Guide](https://github.com/lfnovo/open-notebook/blob/main/docs/features/ollama.md) first
|
||||
|
||||
5. 💬 **[Discord Community](https://discord.gg/37XJPXfz2w)** - Get real-time help from the community
|
||||
|
||||
---
|
||||
|
||||
If you've tried the above and still need help, please fill out the form below with as much detail as possible.
|
||||
|
||||
- type: dropdown
|
||||
id: installation-method
|
||||
attributes:
|
||||
label: Installation Method
|
||||
description: How are you trying to install Open Notebook?
|
||||
options:
|
||||
- Docker (single container - v1-latest-single)
|
||||
- Docker (multi-container - docker-compose)
|
||||
- Local development (make start-all)
|
||||
- Other (please specify below)
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: issue-description
|
||||
attributes:
|
||||
label: What is the issue?
|
||||
description: Describe the installation or setup problem you're experiencing
|
||||
placeholder: |
|
||||
Example: "I can't connect to the database" or "The container won't start" or "Getting 404 errors when accessing the UI"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: logs
|
||||
attributes:
|
||||
label: Logs
|
||||
description: |
|
||||
Please provide relevant logs. **This is very important for diagnosing issues!**
|
||||
|
||||
**How to get logs:**
|
||||
- Docker single container: `docker logs open-notebook`
|
||||
- Docker Compose: `docker compose logs -f`
|
||||
- Specific service: `docker compose logs -f open_notebook`
|
||||
placeholder: |
|
||||
Paste your logs here. Include the full error message and stack trace if available.
|
||||
render: shell
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: docker-compose
|
||||
attributes:
|
||||
label: Docker Compose Configuration
|
||||
description: |
|
||||
If using Docker Compose, please paste your `docker-compose.yml` file here.
|
||||
|
||||
**⚠️ IMPORTANT: Redact any sensitive information (API keys, passwords, etc.)**
|
||||
placeholder: |
|
||||
services:
|
||||
open_notebook:
|
||||
image: lfnovo/open_notebook:v1-latest-single
|
||||
ports:
|
||||
- "8502:8502"
|
||||
- "5055:5055"
|
||||
environment:
|
||||
- OPENAI_API_KEY=sk-***REDACTED***
|
||||
...
|
||||
render: yaml
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: env-file
|
||||
attributes:
|
||||
label: Environment File
|
||||
description: |
|
||||
If using an `.env` or `docker.env` file, please paste it here.
|
||||
|
||||
**⚠️ IMPORTANT: REDACT ALL API KEYS AND PASSWORDS!**
|
||||
placeholder: |
|
||||
SURREAL_URL=ws://surrealdb:8000/rpc
|
||||
SURREAL_USER=root
|
||||
SURREAL_PASSWORD=***REDACTED***
|
||||
OPENAI_API_KEY=sk-***REDACTED***
|
||||
ANTHROPIC_API_KEY=sk-ant-***REDACTED***
|
||||
render: shell
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: system-info
|
||||
attributes:
|
||||
label: System Information
|
||||
description: Tell us about your setup
|
||||
placeholder: |
|
||||
- Operating System: Ubuntu 22.04 / Windows 11 / macOS 14
|
||||
- Docker version: `docker --version`
|
||||
- Docker Compose version: `docker compose version`
|
||||
- Architecture: amd64 / arm64 (Apple Silicon)
|
||||
- Available disk space: `df -h`
|
||||
- Available memory: `free -h` (Linux) or Activity Monitor (Mac)
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: additional-context
|
||||
attributes:
|
||||
label: Additional Context
|
||||
description: Any other information that might be helpful
|
||||
placeholder: |
|
||||
- Are you behind a corporate proxy or firewall?
|
||||
- Are you using a VPN?
|
||||
- Have you made any custom modifications?
|
||||
- Did this work before and suddenly break?
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: checkboxes
|
||||
id: checklist
|
||||
attributes:
|
||||
label: Pre-submission Checklist
|
||||
description: Please confirm you've tried these steps
|
||||
options:
|
||||
- label: I tried the [Installation Assistant ChatGPT](https://chatgpt.com/g/g-68776e2765b48191bd1bae3f30212631-open-notebook-installation-assistant)
|
||||
required: false
|
||||
- label: I read the relevant documentation ([Installation Guide](https://github.com/lfnovo/open-notebook/blob/main/docs/getting-started/installation.md) or [Ollama Guide](https://github.com/lfnovo/open-notebook/blob/main/docs/features/ollama.md))
|
||||
required: false
|
||||
- label: I searched existing issues to see if this was already reported
|
||||
required: true
|
||||
- label: I redacted all sensitive information (API keys, passwords, etc.)
|
||||
required: true
|
||||
Loading…
Add table
Add a link
Reference in a new issue