Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Nov 17, 2025

Simplify GitHub issue templates to reduce complexity while maintaining important context for Co-Pilot

Changes Made

  • Simplify bug_report.yml - reduce from 9 to 3 required fields

    • Combined "Description", "Expected Behavior", and "Actual Behavior" into single "What happened?" field
    • Removed separate input fields for Module Version, Terraform Version, AWS Provider Version
    • Removed AWS Region dropdown (now part of config comments)
    • Consolidated version info into Terraform Configuration field with comment placeholders
    • Made "Error Messages / Logs" and "Additional Context" optional
    • Removed Code of Conduct checkbox
  • Simplify feature_request.yml - reduce from 5 to 1 required field

    • Combined "Problem Statement", "Proposed Solution", and "Use Case" into single "What would you like to see?" field
    • Removed "Feature Category" dropdown
    • Removed "Priority" dropdown
    • Made "Example Usage" optional (previously "Example Configuration")
    • Made "Additional Context" optional (now includes alternatives considered)
    • Removed "Contribution" checkbox
    • Removed Code of Conduct checkbox
  • Fixed trailing whitespace in YAML files (pre-commit check)

Summary

Bug Report: Reduced from 9 required fields to 3 required fields (What happened?, Steps to Reproduce, Terraform Configuration)
Feature Request: Reduced from 5 required fields to 1 required field (What would you like to see?)

Both templates now have clearer, more concise prompts with helpful placeholders that guide users to provide essential information without overwhelming them with numerous fields.

Original prompt

The Issue templates are far too complex and onerous to complete.

The current issue templates in cloudandthings/terraform-aws-github-runners are quite detailed, requiring multiple sections and dropdowns for both bug reports and feature requests. Each template asks for several required fields (environment details, configuration snippets, dropdowns for categories or priorities, checkboxes for code of conduct, etc.), which can be onerous for users to complete.

Simplify them significantly, while still including important context for Co-Pilot to be able to work on issues that are logged.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI changed the title [WIP] Simplify issue templates for better usability Simplify issue templates Nov 17, 2025
Copilot AI requested a review from baolsen November 17, 2025 13:27
@baolsen baolsen marked this pull request as ready for review November 17, 2025 13:30
@baolsen
Copy link
Contributor

baolsen commented Nov 17, 2025

@copilot fix failing ci

Copy link
Contributor Author

Copilot AI commented Nov 17, 2025

@copilot fix failing ci

The CI is failing due to PR title validation. The title "Simplify issue templates" needs to follow conventional commit format.

Please update the PR title to one of these:

  • docs: Simplify issue templates
  • chore: Simplify issue templates

Since this changes documentation/templates (not code), docs: would be most appropriate.

The validation requires:

  • Prefix with: fix, feat, docs, ci, or chore
  • Subject must start with uppercase letter

@baolsen
Copy link
Contributor

baolsen commented Nov 17, 2025

@copilot the ci is failing because precommit is not running successfully

Copy link
Contributor Author

Copilot AI commented Nov 17, 2025

@copilot the ci is failing because precommit is not running successfully

Fixed in commit 4468928. The pre-commit check was failing due to trailing whitespace in the YAML files. The placeholder text had spaces after empty lines which have now been removed.

@baolsen baolsen changed the title Simplify issue templates docs: Simplify issue templates Nov 17, 2025
@baolsen baolsen merged commit 72721e2 into main Nov 17, 2025
20 of 23 checks passed
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