Skip to content

Add general issue template for GitHub issues #2684

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add general issue template for GitHub issues #2684

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions .github/ISSUES_TEMPLATE/issue_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
name: 📝 General Issue Template
about: Report a bug, suggest a feature, or request an enhancement
title: "[TYPE] Short issue summary"
labels: []
assignees: ""
---

## 🧭 Issue Type
<!-- Please select one -->
- [ ] 🐞 Bug
- [ ] 💡 Feature Request
- [ ] 🚀 Enhancement

---

## 📝 Description
<!-- A clear and concise description of the issue. -->

---

## 🔍 Steps to Reproduce (for bugs)
1.
2.
3.

---

## ✅ Expected Behavior
<!-- What did you expect to happen? -->

---

## 🧩 Actual Behavior (for bugs)
<!-- What actually happened? Include screenshots or logs if applicable. -->

---

## 💡 Suggested Solution / Implementation
<!-- If you have an idea for how to fix or improve it, describe it here. -->

---

## 🧰 Additional Context
<!-- Add any other context, links, or screenshots about the issue here. -->

---

### 🏷️ Notes for Maintainers
<!-- Optional: Mention any labels or reviewers you recommend. -->
Comment on lines +1 to +50
Copy link
Contributor

@coderabbitai coderabbitai bot Oct 28, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

Critical: Directory name should be ISSUE_TEMPLATE (singular), not ISSUES_TEMPLATE.

GitHub's native issue template discovery specifically looks for .github/ISSUE_TEMPLATE/ with a singular "ISSUE". The current path .github/ISSUES_TEMPLATE/ (plural "ISSUES") will prevent GitHub from automatically recognizing this template and offering it to users.

Move this file to .github/ISSUE_TEMPLATE/issue_template.md to enable proper template discovery.

🤖 Prompt for AI Agents 
.github/ISSUES_TEMPLATE/issue_template.md lines 1-50: The file is in the wrong
directory name — GitHub expects .github/ISSUE_TEMPLATE (singular). Move this
file from .github/ISSUES_TEMPLATE/issue_template.md to
.github/ISSUE_TEMPLATE/issue_template.md so GitHub will automatically discover
and present the template; ensure the filename and path are exact and update any
references if present.