Skip to content

update ISSUE_TEMPLATE.md#26

Merged
ravnoor merged 3 commits intomainfrom
update_issue_template
Oct 21, 2025
Merged

update ISSUE_TEMPLATE.md#26
ravnoor merged 3 commits intomainfrom
update_issue_template

Conversation

@ravnoor
Copy link
Copy Markdown
Contributor

@ravnoor ravnoor commented Mar 6, 2024

This pull request revamps the issue reporting workflow by replacing the old freeform markdown template with structured YAML-based issue forms and configuration. The new approach improves clarity and consistency for bug reports, feature requests, and questions, making it easier for users to provide complete information and for maintainers to triage and address issues efficiently.

Migration to Structured Issue Forms:

  • Added new YAML-based issue templates for bug reports, feature requests, and questions in .github/ISSUE_TEMPLATE/, each with guided fields, dropdowns, and validation to ensure comprehensive submissions. [1] [2] [3]
  • Removed the legacy markdown issue template .github/ISSUE_TEMPLATE.md, eliminating unstructured submissions.

Improvements to Project Configuration and User Guidance:

  • Introduced .github/ISSUE_TEMPLATE/config.yml to disable blank issues and provide direct links to documentation and discussions, steering users toward helpful resources and community support.

@ravnoor ravnoor requested a review from Copilot October 21, 2025 00:24
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the issue template to provide clearer guidance for bug reports and reflects more current software versions. The changes improve the template's usefulness by requesting additional debugging information and updating example versions to more recent releases.

Key changes:

  • Enhanced description section to request the actual command executed
  • Updated macOS version example from 11.6.5 to 14.2.1
  • Updated Ubuntu version example from 20.04.3 to 22.04.4

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Copy link
Copy Markdown
Contributor Author

@ravnoor ravnoor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ravnoor ravnoor requested a review from Copilot October 21, 2025 00:39
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

ravnoor and others added 3 commits October 20, 2025 21:05
- update OS versions
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
- add bug reports, feature requests, and questions
@ravnoor ravnoor force-pushed the update_issue_template branch from b04ae50 to 537d374 Compare October 21, 2025 01:06
@ravnoor ravnoor self-assigned this Oct 21, 2025
@ravnoor ravnoor merged commit dc06def into main Oct 21, 2025
6 checks passed
@ravnoor ravnoor deleted the update_issue_template branch October 21, 2025 01:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants