issue template: put instructions in comments so they don't appear in the issue

[jonathanperret]

🤔 Problem

Having an issue template is great, but people don't always think to remove the instructions (such as A clear and concise description of what you expected to happen.) when filing an issue.

This results in slightly confusing reports where the instructions appear together with the actual issue content.

💡 Proposed solution

Putting the instructions in markdown comment blocks at least prevents them from visually polluting the resulting issue.

Summary by CodeRabbit

• Documentation
  • Updated the bug report template to use HTML comments for guidance, enhancing user experience by clarifying instructions without cluttering the visible content.

[coderabbitai]

Walkthrough

The changes involve modifying the .github/ISSUE_TEMPLATE/bug_report.md file by replacing visible prompt text with HTML comment tags. This adjustment ensures that the guidance for users filling out the bug report is not displayed in the rendered markdown, while still providing necessary instructions within the template. The sections affected include descriptions for the bug, expected behavior, screenshots, and additional context.

Changes

File	Change Summary
.github/ISSUE_TEMPLATE/bug_report.md	Replaced visible prompt text with HTML comment tags to clarify user guidance without rendering it.

Sequence Diagram(s)

%% No sequence diagrams generated as changes are too simple to require visualization.

Loading

Tip

OpenAI O1 model for chat

• We have deployed OpenAI's latest O1 model for chat.
• OpenAI claims that this model has superior reasoning capabilities than their GPT-4o model.
• Please share any feedback with us in the discussions post.

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 06e2258 and 8e22084.

Files selected for processing (1)

• .github/ISSUE_TEMPLATE/bug_report.md (2 hunks)

Files skipped from review due to trivial changes (1)

• .github/ISSUE_TEMPLATE/bug_report.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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

[dl1com]

Let's see how it goes, there might be users putting their text inside the comment now....but let's give it a try

[jonathanperret]

Let's see how it goes, there might be users putting their text inside the comment now....but let's give it a try

Yes, this would be the risk. We’ll see.