Update ISSUE_TEMPLATE.md

[Zaid-B24]

✨ Codu Pull Request 💻

Fixes #(1021)

Pull Request details

• Modified ISSUE_TEMPLATE.md, file.
• Each section’s instructions are now wrapped in "" tags, which makes them hidden in the issue preview.
• Users will only see the headers (e.g., “## Expected Behavior”) and can add details without needing to delete placeholder instructions.

Any Breaking changes

-None

Associated Screenshots

• None

[Optional] What gif best describes this PR or how it makes you feel

• None

[vercel]

@Zaid-B24 is attempting to deploy a commit to the Codú Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai]

Walkthrough

The changes in this pull request modify the ISSUE_TEMPLATE.md file by converting comments from plain text to HTML comment syntax. Each section header now includes specific prompts for users to provide detailed information about their setup, expected behavior, current behavior, screenshots, steps to reproduce, and additional information. Minor punctuation adjustments were also made, including the addition of periods and a reformatting of the steps to reproduce section into a numbered list.

Changes

File	Change Summary
.github/ISSUE_TEMPLATE.md	Changed comments to HTML syntax, added prompts for user input in each section, minor punctuation adjustments, and reformatted steps to reproduce into a numbered list.

Possibly related PRs

• Add issue number prompt in pull_request_template.md #1019: The changes in this PR also modify the .github/pull_request_template.md file, adding a prompt for issue numbers, which is related to enhancing the template's usability similar to the changes made in the main PR.
• chore: added gif request to pr template #1180: This PR introduces a new optional section in the .github/pull_request_template.md file, which aligns with the main PR's focus on improving the template's structure and user guidance.

Poem

🐰 In the garden of issues, we tidy and mend,
With prompts and with comments, our help we extend.
Each step now is numbered, clear as can be,
For bunnies and coders, a smoother journey!
So hop to it, dear friends, let’s file with delight,
Our templates are shining, all ready for flight! 🌼

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 2cb44b3 and c226543.

📒 Files selected for processing (1)

• ISSUE_TEMPLATE.md (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• ISSUE_TEMPLATE.md

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

Hello @Zaid-B24, thanks for opening your first Pull Request. The maintainers will review this Pull Request and provide feedback as soon as possible. Keep up the great work!

[JohnAllenTech]

This is so smart. This annoys me every time I write a PR here