Skip to content

[MAINT] Update issue templates#3261

Open
ViacheslavKudinov wants to merge 10 commits intointegrations:mainfrom
ViacheslavKudinov:main
Open

[MAINT] Update issue templates#3261
ViacheslavKudinov wants to merge 10 commits intointegrations:mainfrom
ViacheslavKudinov:main

Conversation

@ViacheslavKudinov
Copy link
Contributor

@ViacheslavKudinov ViacheslavKudinov commented Mar 7, 2026

This pull request updates the GitHub issue templates to improve clarity, collect more relevant information, and streamline the reporting process. The most significant changes include adding a required "GitHub Installation Type" field to several templates, removing unused SDK/API version fields, and refining instructions to help users provide better context and redact sensitive information.

Enhancements to information collection:

  • Added a required "GitHub Installation Type" checkbox field to the bug and feature request templates, allowing users to specify their GitHub environment (Cloud, Enterprise, etc.), which will help triage and diagnose issues more effectively. (.github/ISSUE_TEMPLATE/bug.yml, .github/ISSUE_TEMPLATE/feature.yml) [1] [2]
  • Removed optional SDK and API version input fields from the documentation, feature, and maintenance templates to simplify the forms and focus on more actionable information. (.github/ISSUE_TEMPLATE/documentation.yml, .github/ISSUE_TEMPLATE/feature.yml, .github/ISSUE_TEMPLATE/maintenance.yml) [1] [2] [3]

Improvements to user instructions and template clarity:

  • Updated instructions and placeholders throughout the bug template to encourage redacting sensitive information, clarify what configuration details are needed (including module context), and request additional context for reproducing issues. (.github/ISSUE_TEMPLATE/bug.yml) [1] [2] [3]
  • Revised the debug output section in the bug template to explicitly request logs generated with TF_LOG=DEBUG and remind users to redact sensitive data. (.github/ISSUE_TEMPLATE/bug.yml)

General template maintenance:

  • Added minor formatting improvements and whitespace consistency across all templates for better readability. (.github/ISSUE_TEMPLATE/documentation.yml, .github/ISSUE_TEMPLATE/feature.yml, .github/ISSUE_TEMPLATE/maintenance.yml) [1] [2] [3]
  • Ensured all templates include a terms and conditions checkbox for user acknowledgment. (.github/ISSUE_TEMPLATE/documentation.yml, .github/ISSUE_TEMPLATE/feature.yml, .github/ISSUE_TEMPLATE/maintenance.yml) [1] [2] [3]

@github-actions
Copy link

github-actions bot commented Mar 7, 2026

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labeled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

@ViacheslavKudinov ViacheslavKudinov changed the title [MAINT] Update issue temapltaes [MAINT] Update issue temaplates Mar 7, 2026
Copy link
Collaborator

@deiga deiga left a comment

Choose a reason for hiding this comment

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

Great initiative!

I left some suggestion for the Bug to make it even more useful (hopefully)

ViacheslavKudinov and others added 7 commits March 7, 2026 22:28
Co-authored-by: Timo Sand <timo.sand@iki.fi>
Co-authored-by: Timo Sand <timo.sand@iki.fi>
Co-authored-by: Timo Sand <timo.sand@iki.fi>
@ViacheslavKudinov ViacheslavKudinov marked this pull request as ready for review March 10, 2026 17:53
@ViacheslavKudinov ViacheslavKudinov changed the title [MAINT] Update issue temaplates [MAINT] Update issue templates Mar 10, 2026
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