VigyBag icon indicating copy to clipboard operation
VigyBag copied to clipboard

Add general issue template for GitHub issues

Open Aarushjain2401 opened this issue 1 month ago • 3 comments

Fixes Issue

Changes proposed

Screenshots

Note to reviewers

Summary by CodeRabbit

  • Chores
    • Added a new issue template to standardize issue submissions with predefined sections for issue type, description, reproduction steps, expected/actual behavior, suggested solutions, additional context, and maintainer notes.

Aarushjain2401 avatar Oct 28 '25 12:10 Aarushjain2401

@Aarushjain2401 is attempting to deploy a commit to the Vivek Prajapati's projects Team on Vercel.

A member of the Team first needs to authorize it.

vercel[bot] avatar Oct 28 '25 12:10 vercel[bot]

Walkthrough

A new GitHub issue template file is added at .github/ISSUES_TEMPLATE/issue_template.md containing YAML configuration and structured form sections for standardizing issue submissions. The template includes fields for issue type, description, reproduction steps, expected and actual behavior, solutions, context, and maintainer notes.

Changes

Cohort / File(s) Change Summary
GitHub Issue Template
\.github/ISSUES_TEMPLATE/issue_template.md
New file added with YAML front matter (name, about, title, labels, assignees) and multi-section form structure for standardized issue reporting.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

  • Static template file with no executable code or logic
  • Simple structural addition with no dependencies or integration points

Poem

🐰 A template so neat, with sections aligned, To guide every issue through structure refined! From type unto context, a pathway so clear, No more scattered reports—just order right here! ✨

Pre-merge checks and finishing touches

❌ Failed checks (2 warnings)
Check name Status Explanation Resolution
Description Check ⚠️ Warning The pull request description contains the correct template structure with all required sections present (Fixes Issue, Changes proposed, Screenshots, and Note to reviewers), but all content sections are completely empty and contain only template placeholder comments. The author has not filled in any substantive information about what changes are being made, why they are being made, or any supporting context. While the structure matches the template, the description lacks the actual content needed to understand the purpose and scope of the pull request. The author should fill in the "Changes proposed" section to describe what the new issue template includes and why it was added. The "Fixes Issue" section can be removed if this PR doesn't address a specific issue, and the "Screenshots" and "Note to reviewers" sections should be completed or removed as appropriate. At minimum, the description needs substantive content explaining the changes rather than just the empty template placeholders.
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (1 passed)
Check name Status Explanation
Title Check ✅ Passed The pull request title "Add general issue template for GitHub issues" is directly and clearly related to the main change in the changeset, which adds a new issue template file at .github/ISSUES_TEMPLATE/issue_template.md. The title is concise, specific, and accurately summarizes what was added without vague language or unnecessary details. A teammate reviewing the history would immediately understand the primary purpose of this change.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • [ ] Create PR with unit tests
  • [ ] Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

coderabbitai[bot] avatar Oct 28 '25 12:10 coderabbitai[bot]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
vigybag Ready Ready Preview Comment Nov 4, 2025 3:20pm

vercel[bot] avatar Nov 04 '25 15:11 vercel[bot]