create-adapter icon indicating copy to clipboard operation
create-adapter copied to clipboard

Convert bug report template to GitHub issue forms and add feature request template

Open Copilot opened this issue 4 months ago • 0 comments

Overview

This PR converts the bug report template from Markdown format to GitHub issue forms (YAML) and adds a new feature request template, following the pattern used in ioBroker.trashschedule.

Changes

Bug Report Template (Converted to YAML)

Replaced the free-form Markdown template with a structured GitHub issue form that includes:

Required fields:

  • Bug description (textarea with placeholder)
  • Steps to reproduce (textarea with example steps)
  • Expected behavior (textarea)
  • Adapter version (input field)
  • JS-Controller version (input field)
  • Node version (input field)
  • Operating system (input field)

Optional fields:

  • Checkboxes for log files and screenshots
  • Additional logs/screenshots section (with file upload support)
  • Additional context (textarea)

Guidance:

  • Introduction message explaining how to use the form
  • Links to ioBroker forum for support questions
  • Clear instructions to ensure bug is reproducible with current version

Feature Request Template (New)

Added a new structured form for feature requests with:

Required fields:

  • Proposed solution description

Optional fields:

  • Problem description
  • Alternative solutions considered
  • Additional context

Guidance:

  • Clear instructions about feature request scope
  • Links to ioBroker forum for general questions
  • Reminders to check if feature already exists

Benefits of GitHub Issue Forms

  1. Structured Data - Form responses are automatically parsed into structured data that can be processed by automation tools
  2. Required Field Validation - GitHub enforces that required fields are filled before submission
  3. Better User Experience - Users are guided through labeled form fields with placeholders and descriptions instead of editing Markdown
  4. Consistency - All bug reports and feature requests follow the same format
  5. File Upload Support - Native support for drag-and-drop file uploads in designated fields

Migration

This change only affects newly created adapters. Existing adapters continue to work without any changes.

For adapter maintainers who want to adopt the new issue forms, migration instructions are provided in docs/updates/20251014_github_issue_forms.md.

Testing

  • ✅ All 50 baseline tests passing
  • ✅ Build successful
  • ✅ Template files correctly generated in all test baselines
  • ✅ YAML syntax validated

Related

Closes #XXX (reference to the issue number)


Example of the new bug report form structure:

name: Bug report
description: Something is not working as it should
title: "[Bug]: "
body:
  - type: markdown
    attributes:
      value: >
        **Thank you for wanting to report a bug in this adapter!**
        ...
  
  - type: textarea
    id: bug-description
    attributes:
      label: Describe the bug
      description: A clear and concise description of what the bug is.
    validations:
      required: true
  
  - type: input
    id: adapter-version
    attributes:
      label: Adapter version
      placeholder: e.g., 1.2.3
    validations:
      required: true
  ...

When users create a new issue, they'll see a structured form with labeled fields, placeholders, and validation, making it much easier to provide complete bug reports.

Original prompt

This section details on the original issue you should resolve

<issue_title>Use GitHub issue forms (with yaml) - e.g. for Bug Reports</issue_title> <issue_description>Example: https://github.com/klein0r/ioBroker.trashschedule/issues/new?assignees=&labels=&template=bug_report.yml&title=Bug+report

https://github.com/klein0r/ioBroker.trashschedule/blob/687a05d5cee39534136999d2525a4b27275f64e7/.github/ISSUE_TEMPLATE/bug_report.yml</issue_description>

<agent_instructions>Adjust the current bug report template to use form elements and asdjust the flows and options to combine what's currently asked in the templates with the example forms provided. Also add a new feature template along this idea</agent_instructions>

Comments on the Issue (you are @copilot in this section)

Fixes ioBroker/create-adapter#845


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Copilot avatar Oct 14 '25 07:10 Copilot