Added GH issue templates

This commit is contained in:
Bob Roberts 2025-11-01 14:37:01 -05:00
parent 662f500edb
commit 3f9629b5af
4 changed files with 263 additions and 0 deletions

95
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View file

@ -0,0 +1,95 @@
name: Bug Report
description: Report a bug or unexpected behavior
title: "[Bug] "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report this bug!
- type: textarea
id: description
attributes:
label: Bug Description
description: A clear description of what the bug is
placeholder: Describe what happened vs what you expected to happen
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to Reproduce
description: Steps to reproduce the behavior
placeholder: |
1. Start Claude OS with './start.sh'
2. Run command '/claude-os-search ...'
3. See error
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected Behavior
description: What you expected to happen
placeholder: Describe the expected behavior
validations:
required: true
- type: textarea
id: actual
attributes:
label: Actual Behavior
description: What actually happened
placeholder: Describe what actually happened
validations:
required: true
- type: dropdown
id: component
attributes:
label: Component
description: Which component is affected?
options:
- MCP Server
- Web UI (Frontend)
- Knowledge Base / Search
- Document Processing
- Claude Code Integration
- Other
validations:
required: true
- type: textarea
id: environment
attributes:
label: Environment
description: Your environment details
placeholder: |
- OS: macOS 14.0
- Python: 3.12.0
- Claude OS version: 2.0.0
- How started: ./start.sh or ./start_all_services.sh
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant Logs
description: Any relevant log output
placeholder: Paste relevant log output here
render: shell
validations:
required: false
- type: textarea
id: additional
attributes:
label: Additional Context
description: Any other context about the problem
placeholder: Add any other context, screenshots, etc.
validations:
required: false

11
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View file

@ -0,0 +1,11 @@
blank_issues_enabled: true
contact_links:
- name: Documentation
url: https://github.com/brobertsaz/claude-os/blob/main/README.md
about: Check out the documentation first
- name: Start Scripts Guide
url: https://github.com/brobertsaz/claude-os/blob/main/START_SCRIPTS_GUIDE.md
about: Learn about start.sh vs start_all_services.sh
- name: Backup & Restore Guide
url: https://github.com/brobertsaz/claude-os/blob/main/BACKUP_RESTORE_GUIDE.md
about: How to backup and restore your data

View file

@ -0,0 +1,83 @@
name: Feature Request
description: Suggest a new feature or enhancement
title: "[Feature] "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thanks for suggesting a new feature! We appreciate your ideas.
- type: textarea
id: problem
attributes:
label: Problem Statement
description: What problem does this feature solve?
placeholder: Describe the problem or limitation you're experiencing
validations:
required: true
- type: textarea
id: solution
attributes:
label: Proposed Solution
description: How would you like to see this implemented?
placeholder: Describe your proposed solution
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives Considered
description: What other approaches have you considered?
placeholder: Describe any alternative solutions you've thought about
validations:
required: false
- type: dropdown
id: component
attributes:
label: Component
description: Which component would this affect?
options:
- MCP Server / API
- Web UI (Frontend)
- Knowledge Base / Search
- Document Processing
- Claude Code Integration
- Documentation
- Other
validations:
required: true
- type: dropdown
id: priority
attributes:
label: Priority
description: How important is this feature to you?
options:
- Nice to have
- Would be helpful
- Very important
- Critical
validations:
required: true
- type: textarea
id: use-case
attributes:
label: Use Case
description: Describe how you would use this feature
placeholder: Provide a concrete example of how this would be used
validations:
required: false
- type: textarea
id: additional
attributes:
label: Additional Context
description: Any other context, screenshots, or examples
placeholder: Add any other context about the feature request
validations:
required: false

View file

@ -0,0 +1,74 @@
name: Installation Issue
description: Report problems with the install.sh script
title: "[Install] "
labels: ["installation", "bug"]
body:
- type: markdown
attributes:
value: |
Thanks for reporting an installation issue! This helps us improve Claude OS for everyone.
- type: dropdown
id: os
attributes:
label: Operating System
description: What OS are you running?
options:
- macOS (Intel)
- macOS (Apple Silicon)
- Linux (Ubuntu/Debian)
- Linux (Other)
- Windows (WSL)
- Other
validations:
required: true
- type: input
id: os-version
attributes:
label: OS Version
description: Output of `uname -a` or system version
placeholder: "Darwin 25.0.0 or Ubuntu 22.04"
validations:
required: true
- type: input
id: python-version
attributes:
label: Python Version
description: Output of `python3 --version`
placeholder: "Python 3.12.0"
validations:
required: true
- type: textarea
id: error-output
attributes:
label: Error Output
description: Paste the complete output from install.sh, including any error messages
placeholder: |
Include the full terminal output here...
render: shell
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to Reproduce
description: What steps did you take before the error occurred?
placeholder: |
1. Cloned the repo
2. Ran ./install.sh
3. Error appeared at...
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Any other information that might help (previous installations, system setup, etc.)
placeholder: Add any other context about the problem here
validations:
required: false