Skip to content

Add GitHub Issue Templates  #4

Description

@Vishvapatel2047

Add GitHub Issue Templates

Problem

The repository currently does not provide GitHub Issue Templates. As a result, contributors may submit issues with inconsistent formatting, omit important information, or provide insufficient details for maintainers to effectively understand and triage the issue.

Proposed Solution

Create a new directory:

.github/ISSUE_TEMPLATE/

Add the following issue templates:

  • Bug Report
  • Feature Request
  • Documentation Improvement (optional)

Each template should guide contributors to provide relevant information, including:

  • Description

    • A clear and concise explanation of the issue or request.
  • Current Behavior

    • Describe what is happening now.
  • Expected Behavior

    • Describe what should happen instead.
  • Steps to Reproduce (for bug reports)

    • Provide a list of steps that consistently reproduce the issue.
  • Screenshots (if applicable)

    • Include screenshots or screen recordings to help illustrate the issue.
  • Additional Context

    • Any extra information that may help maintainers understand or resolve the issue.

Benefits

  • Encourages consistent and well-structured issue reports.
  • Makes issue triaging faster and more efficient.
  • Improves the contributor experience by providing clear guidance.
  • Reduces back-and-forth communication during issue discussions.
  • Helps maintainers gather all necessary information from the initial report.

Metadata

Metadata

Labels

ECSoC26Elite Coders Summer of Code LabelECSoC26-L1level 1

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions