Skip to content

Create Markdown issue templates for bug, feature, and other issue types #124

Description

@kurnakovv

Summary

Create Markdown issue templates for common issue types such as bug reports and feature requests.

Motivation

The repository currently lacks standardized Markdown-based issue templates with consistent structure and template-specific default titles. Adding them will make issue reporting more uniform, easier to triage, and clearer for contributors.

Scope

  • Add Markdown issue templates under .github/ISSUE_TEMPLATE/
  • Create at least templates for:
    • Bug report
    • Feature request
    • Question or support request
  • Define template titles so each template has an appropriate default title/prefix
  • Ensure each template includes clear sections relevant to its type
  • Add any needed config.yml settings for issue template behavior if applicable

Proposed Templates

Bug report

Suggested title pattern:
[Bug]: <short description>

Suggested sections:

  • Summary
  • Steps to reproduce
  • Expected behavior
  • Actual behavior
  • Environment
  • Additional context

Feature request

Suggested title pattern:
[Feature]: <short description>

Suggested sections:

  • Summary
  • Problem to solve
  • Proposed solution
  • Alternatives considered
  • Additional context

Question / support

Suggested title pattern:
[Question]: <short description>

Suggested sections:

  • Question
  • What you tried
  • Relevant configuration or context
  • Additional details

Acceptance Criteria

  • Markdown issue templates are added for bug, feature, and question/support cases
  • Each template defines a clear template name, description, and default title format
  • Templates use repository-appropriate wording for biak
  • Template content is concise, actionable, and easy to fill out
  • GitHub recognizes the templates in the repository issue chooser

Notes

This repository is a C# tool for managing .editorconfig rules, so templates should encourage reporters to include configuration snippets, rule names, imports, variables, formatting expectations, and conflict details when relevant.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingenhancementNew feature or requestquestionFurther information is requested

    Projects

    Status
    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions