mirror of
https://github.com/lfnovo/open-notebook.git
synced 2026-04-30 12:30:01 +00:00
1331e0feec
* chore: bump esperanto for anthropic on langchain * docs: improve contribution workflow and project governance Implements a comprehensive contribution management system to maintain project quality and vision while welcoming community contributions. Key Changes: - Updated CONTRIBUTING.md with clear issue-first workflow - Added "willing to contribute" checkbox to issue templates - Created DESIGN_PRINCIPLES.md documenting project vision and principles - Added comprehensive PR template with quality checklists - Created MAINTAINER_GUIDE.md with review processes and templates - Added .github/README.md explaining the contribution flow Benefits: - Prevents wasted effort on misaligned contributions - Maintains architectural consistency - Provides clear expectations for contributors - Gives maintainers tools to manage contributions effectively - Educates contributors on project goals and standards Related to managing increased community contributions while maintaining project direction.
104 lines
3.3 KiB
YAML
104 lines
3.3 KiB
YAML
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
|
|
|
|
- type: checkboxes
|
|
id: willing-to-contribute
|
|
attributes:
|
|
label: Contribution
|
|
description: Would you like to work on fixing this bug?
|
|
options:
|
|
- label: I am a developer and would like to work on fixing this issue (pending maintainer approval)
|
|
required: false
|
|
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
---
|
|
**Next Steps:**
|
|
1. A maintainer will review your bug report
|
|
2. If you checked the box above and want to fix it, please propose your solution approach
|
|
3. Wait for assignment before starting development
|
|
4. See our [Contributing Guide](https://github.com/lfnovo/open-notebook/blob/main/CONTRIBUTING.md) for more details
|