Skip to content

Improve and Standardize GitHub Issue Template for Better Clarity #133

@dimpal-yadav

Description

@dimpal-yadav

📝 Description:
The current issue template is too generic and doesn’t differentiate between bug reports, feature requests, and documentation updates. A redesigned template will provide structured guidance based on the type of issue being submitted.

💡 Expected Improvements:
Separate sections for:
🐞 Bug Report – Steps to reproduce, expected vs actual behavior, environment.
✨ Feature Request – Description, use-case, expected solution.
📚 Documentation Update – Current vs suggested documentation, links.
Clear checklists to ensure contributors provide all necessary details.
Optional screenshots, code snippets, or relevant links.
Predefined labels based on issue type for easy triaging.

✅ Benefits:
Reduces incomplete issue submissions.
Provides maintainers with all necessary context upfront.
Improves contribution experience and reduces review time.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationlevel 1awards 2 points

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions