Skip to content

Conversation

@harryswift01
Copy link
Contributor

Summary

This PR introduces a set of GitHub issue templates. These changes improve the contributor experience by providing clearly structured options for reporting issues and requesting documentation updates.

Changes

Add issue templates for various report types

  • Added structured templates to support clearer and more consistent issue reporting.
  • Enables users to quickly choose the correct issue category.

Add documentation issue template

  • Introduced a dedicated template for documentation-related improvements or changes.
  • Helps separate documentation issues from general or bug reports.

Add general report issue template

  • Added a template to capture issues or requests that do not fall under a specific category.
  • Provides a fallback option for contributors.

Impact

  • Improves the contributor workflow by enabling GitHub’s issue template picker.
  • Standardises and clarifies issue reporting across the repository.
  • Reduces ambiguity and improves issue triage for maintainers.

@harryswift01 harryswift01 requested a review from jimboid January 15, 2026 14:13
@harryswift01 harryswift01 self-assigned this Jan 15, 2026
@harryswift01 harryswift01 linked an issue Jan 15, 2026 that may be closed by this pull request
@harryswift01 harryswift01 changed the title Enable Issue Template Picker by Adding Templates and Adding File Extension Enable Issue Template Picker by Adding Templates and Adding Configuration File Jan 15, 2026
Copy link
Member

@jimboid jimboid left a comment

Choose a reason for hiding this comment

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

This is cool! Well done Harry. Let's see how it works and then I think this would be good to add to some other repos.

@harryswift01 harryswift01 merged commit 54e04ff into main Jan 16, 2026
15 checks passed
@harryswift01 harryswift01 deleted the 248-add-configyaml branch January 16, 2026 15:46
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.

Add config.yaml to Enable GitHub Issue Template Selection

3 participants