Skip to content

[Feature] Add Standardized GitHub Issue Templates for Bug Reports and Feature Requests #59

@kunalverma2512

Description

@kunalverma2512

Description

Currently, the repository does not provide structured issue creation workflows for contributors. As a result, issues are often created with inconsistent formatting, incomplete details, unclear reproduction steps, or vague implementation requirements, making issue triaging and maintenance more difficult.

To improve repository organization, contributor experience, and maintainer workflow, we need to introduce standardized GitHub Issue Templates using GitHub Issue Forms.

The repository should support structured issue creation for the following categories:

  • Bug Reports
  • Feature Requests
  • Documentation Improvements
  • UI/UX Improvements

These templates should guide contributors to provide all necessary details before submitting an issue, resulting in more actionable, maintainable, and review-ready issue discussions.


Requirements

Create the following directory structure:

.github/ISSUE_TEMPLATE/

Inside the directory, create the following templates:

  • bug_report.yml
  • feature_request.yml
  • documentation.yml
  • ui_ux_improvement.yml

Template Requirements

1. Bug Report Template

The bug report template should collect:

  • Bug summary
  • Steps to reproduce
  • Expected behavior
  • Actual behavior
  • Screenshots / recordings
  • Browser / device information
  • Additional context

This template should help maintainers reproduce and debug issues more efficiently.


2. Feature Request Template

The feature request template should collect:

  • Problem statement
  • Proposed solution
  • Alternative solutions considered
  • Use case / motivation
  • References or mockups
  • Additional context

This template should encourage contributors to submit well-structured and implementation-focused feature proposals.


3. Documentation Improvement Template

The documentation template should collect:

  • Documentation issue summary
  • Affected section/file
  • Suggested improvement
  • Reason for improvement
  • Screenshots/references if applicable

This template should help contributors propose clearer, more maintainable, and user-friendly documentation enhancements.


4. UI/UX Improvement Template

The UI/UX template should collect:

  • Current UI/UX issue
  • Proposed improvement
  • Screenshots/mockups
  • Responsive behavior considerations
  • Accessibility considerations
  • Additional implementation notes

This template should standardize frontend enhancement discussions and encourage contributors to provide visual and usability-focused context.

Expected Outcome

After implementation:

  • Contributors should see categorized issue creation options while opening a new issue.
  • Issue submissions should become more structured, detailed, and maintainable.
  • Maintainers should spend less time requesting missing information from contributors.
  • Repository issue management and triaging workflow should become significantly more organized and professional.

Metadata

Metadata

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions