Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
184 changes: 184 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,184 @@
name: 🐛 Bug Report
description: Report issues with the current template or setup
title: "[BUG] "
labels: ["bug"]
assignees: []

body:
- type: markdown
attributes:
value: |
## 🐛 Bug Report for ioBroker Copilot Instructions

Thank you for reporting an issue! This helps us improve the template and setup process for the ioBroker community.

- type: checkboxes
id: prerequisites
attributes:
label: Prerequisites
description: Please confirm you have done the following
options:
- label: I have searched existing issues to ensure this is not a duplicate
required: true
- label: I have followed the setup guide and troubleshooting steps
required: true
- label: This issue is related to the ioBroker Copilot Instructions template or setup process
required: true

- type: dropdown
id: issue-type
attributes:
label: Issue Type
description: What type of issue are you experiencing?
options:
- Template Issue - Problem with template content or structure
- Setup Issue - Problem during installation or configuration
- Bug - Unexpected behavior or error
- Question - Need help understanding something
- Documentation Issue - Unclear or missing documentation
- Automation Issue - Problem with automated updates or scripts
default: 0
validations:
required: true

- type: dropdown
id: severity
attributes:
label: Severity
description: How severe is this issue?
options:
- Low - Minor inconvenience, has workaround
- Medium - Affects functionality but not critical
- High - Significant impact on adapter development
- Critical - Completely blocks adapter development
default: 1
validations:
required: true

- type: textarea
id: current-behavior
attributes:
label: Current Behavior
description: Describe what is happening now
placeholder: |
Describe the current behavior:
- What are you trying to do?
- What happens instead of what you expect?
- Any error messages or unexpected outputs?
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: Describe what you expected to happen
placeholder: |
Describe what should happen:
- What did you expect to occur?
- How should it work based on documentation?
- What would be the ideal outcome?
validations:
required: true

- type: textarea
id: reproduction-steps
attributes:
label: Steps to Reproduce
description: Provide detailed steps to reproduce the issue
placeholder: |
1. Go to...
2. Click on...
3. Run command...
4. See error...
validations:
required: true

- type: dropdown
id: environment-github-copilot
attributes:
label: GitHub Copilot Status
description: Is GitHub Copilot properly set up in your repository?
options:
- "Yes - Copilot is active and working"
- "No - Copilot is not set up"
- "Partial - Copilot works sometimes"
- "Unknown - Not sure if it's working"
default: 0
validations:
required: true

- type: input
id: template-version
attributes:
label: Template Version
description: What version of the template are you using?
placeholder: "e.g., 0.4.0 or 'latest' or 'unknown'"
validations:
required: true

- type: dropdown
id: environment-os
attributes:
label: Operating System
description: What operating system are you using?
options:
- Windows
- macOS
- Linux
- Other (please specify in additional context)
validations:
required: true

- type: input
id: environment-node
attributes:
label: Node.js Version
description: What version of Node.js are you using? (if applicable)
placeholder: "e.g., 18.x, 20.x, or N/A"

- type: textarea
id: error-logs
attributes:
label: Error Messages/Logs
description: Include any relevant error messages, logs, or console output
placeholder: |
Paste error messages or logs here:
```
error log content here
```
render: text

- type: textarea
id: configuration
attributes:
label: Configuration Details
description: Relevant configuration or setup details
placeholder: |
Include relevant details such as:
- Relevant sections from .github/copilot-instructions.md
- Package.json dependencies
- IDE/editor being used
- Any custom configurations

- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Any other context about the problem
placeholder: |
Additional information:
- Screenshots if applicable
- Links to your repository (if public)
- Timeline of when the issue started
- Any recent changes made

- type: checkboxes
id: workaround
attributes:
label: Workaround
description: Have you found any workarounds?
options:
- label: I have found a temporary workaround (please describe in additional context)
- label: I have not found any workaround
- label: I need help finding a workaround
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: true
contact_links:
- name: 💬 Community Discussion
url: https://github.com/DrozmotiX/ioBroker-Copilot-Instructions/discussions
about: Join discussions about best practices, share experiences, and collaborate on improvements
- name: 🌍 ioBroker Community Forum
url: https://forum.iobroker.net/topic/82238/ki-trifft-iobroker-ein-gemeinsames-abenteuer
about: Connect with the broader ioBroker community for adapter development collaboration
- name: 📖 Documentation
url: https://github.com/DrozmotiX/ioBroker-Copilot-Instructions/tree/main/docs
about: Complete setup guides, automated updates documentation, and best practices
178 changes: 178 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_automation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,178 @@
name: 📚 Documentation & Automation Improvement
description: Suggest improvements to documentation, setup processes, or automation
title: "[DOCS/AUTO] "
labels: ["documentation", "automation", "enhancement"]
assignees: []

body:
- type: markdown
attributes:
value: |
## 📚 Documentation & Automation Improvement

Thank you for suggesting improvements! This template helps us enhance documentation, setup processes, and automation to better serve the ioBroker community.

- type: checkboxes
id: prerequisites
attributes:
label: Prerequisites
description: Please confirm you have reviewed existing resources
options:
- label: I have searched existing issues to ensure this is not a duplicate
required: true
- label: I have reviewed the current documentation and setup guides
required: true
- label: This improvement would benefit the broader ioBroker adapter development community
required: true

- type: dropdown
id: improvement-type
attributes:
label: Improvement Type
description: What type of improvement are you suggesting?
options:
- Documentation - Improve existing docs or add missing docs
- Setup Process - Improve installation or configuration steps
- Automation - Improve scripts, tools, or automated processes
- Testing - Improve validation or testing procedures
- User Experience - Improve usability of templates or tools
- Community Resources - Improve community support materials
- Other (please specify)
default: 0
validations:
required: true

- type: dropdown
id: target-audience
attributes:
label: Target Audience
description: Who would benefit most from this improvement?
options:
- New ioBroker adapter developers
- Experienced adapter developers
- Template maintainers
- Community contributors
- All users
default: 4
validations:
required: true

- type: textarea
id: current-situation
attributes:
label: Current Situation
description: Describe the current state and what needs improvement
placeholder: |
Describe what exists now:
- What documentation/automation currently exists?
- What are the current pain points or limitations?
- What makes the current approach difficult or confusing?
validations:
required: true

- type: textarea
id: proposed-improvement
attributes:
label: Proposed Improvement
description: Describe your suggested improvement in detail
placeholder: |
Describe your proposed improvement:
- What specifically should be improved or added?
- How would this make things better?
- What would the improved workflow/documentation look like?
validations:
required: true

- type: textarea
id: examples-references
attributes:
label: Examples & References
description: Provide examples or references that support your suggestion
placeholder: |
Supporting examples:
- Links to good documentation examples from other projects
- Screenshots of confusing sections (if applicable)
- Examples from the ioBroker community
- References to best practices

- type: dropdown
id: priority-impact
attributes:
label: Priority & Impact
description: How would you rate the impact and priority of this improvement?
options:
- Low Impact - Nice to have improvement
- Medium Impact - Would help some users significantly
- High Impact - Would help most users significantly
- Critical Impact - Essential for community success
default: 1
validations:
required: true

- type: checkboxes
id: improvement-areas
attributes:
label: Specific Areas for Improvement
description: Select all areas that would benefit from this improvement
options:
- label: Setup and installation process
- label: Template integration steps
- label: GitHub Copilot configuration
- label: Troubleshooting and error handling
- label: Version management and updates
- label: Testing and validation procedures
- label: Community contribution guidelines
- label: Examples and use cases
- label: API/script documentation
- label: Automated tools and scripts

- type: textarea
id: implementation-suggestions
attributes:
label: Implementation Suggestions
description: If you have ideas about how to implement this improvement
placeholder: |
Implementation ideas:
- Changes to specific documentation files
- New documentation sections needed
- Script or automation improvements
- Process changes
- Tools or resources that could help

- type: textarea
id: success-criteria
attributes:
label: Success Criteria
description: How would we know this improvement was successful?
placeholder: |
Success would be measured by:
- Reduced confusion or support requests
- Faster setup/onboarding for new users
- More successful template integrations
- Better community engagement
- Specific metrics or feedback

- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Any other information that would help with this improvement
placeholder: |
Additional information:
- User feedback or common questions you've seen
- Specific scenarios where current approach fails
- Timeline considerations
- Resources you could provide to help

- type: checkboxes
id: contribution
attributes:
label: Contribution
description: How can you help with this improvement?
options:
- label: I can help write or review documentation
- label: I can help test the improved process
- label: I can provide feedback during development
- label: I can help with implementation (scripts/automation)
- label: I can help gather community feedback
- label: I can provide examples or use cases
Loading