Update issue templates

[hoptical]

Summary by CodeRabbit

• Documentation
  • Introduced templates for bug reporting and feature requests to streamline user submissions.

[coderabbitai]

Walkthrough

The recent update introduces templates for bug reports and feature requests on GitHub. These templates are designed to streamline the process of submitting bugs and proposing new features by providing structured formats. The bug report template guides users through detailing the bug, including steps to reproduce, expected behavior, and version information. The feature request template focuses on describing the problem, suggesting a solution, considering alternatives, and providing context.

Changes

File Path	Change Summary
.github/ISSUE_TEMPLATE/bug_report.md	Added a template for bug reports with detailed sections.
.github/ISSUE_TEMPLATE/feature_request.md	Added a template for feature requests with structured sections.

🐰✨
In the garden of code, where bugs often hide,
A rabbit hopped in, with templates as its guide.
"Report your bugs, and features request,
With these new forms, we'll handle the rest."
Through fields of code, it leaps and bounds,
A smoother journey, with templates found.
🌟📝

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-tests 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 tests 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 tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between cc9e6fc and ded776c.

Files selected for processing (2)

• .github/ISSUE_TEMPLATE/bug_report.md (1 hunks)
• .github/ISSUE_TEMPLATE/feature_request.md (1 hunks)

Files skipped from review due to trivial changes (1)

• .github/ISSUE_TEMPLATE/feature_request.md

Additional comments: 5

.github/ISSUE_TEMPLATE/bug_report.md (5)

• 1-8: The header metadata is well-structured and clearly defines the purpose and default settings for the bug report template.
• 10-11: The "Describe the bug" section is clear and prompts for a concise bug description, which is crucial for understanding the issue.
• 13-14: The "To Reproduce" section is well-phrased and critical for understanding how to replicate the bug.
• 16-17: The "Expected behavior" section effectively asks for a description of what should happen, providing a clear contrast to the bug.
• 19-20: The "Screenshots" section is a valuable addition, enabling submitters to provide visual evidence of the bug.

[coderabbitai]

The "Versions" and "Additional context" sections are crucial for providing detailed information about the environment in which the bug occurs. However, there's a minor typographical error in the spelling of "OpenShift".

- - Openshift: [e.g. v4.10]
+ - OpenShift: [e.g. v4.10]

---

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

	**Versions**
	- Operator: [e.g. v0.3.6]
	- Kubernetes: [e.g. v1.27.3]
	- Openshift: [e.g. v4.10]
	- Ceph: [e.g. v14.2.22]
	**Additional context**
	Add any other context about the problem here.
	**Versions**
	- Operator: [e.g. v0.3.6]
	- Kubernetes: [e.g. v1.27.3]
	- OpenShift: [e.g. v4.10]
	- Ceph: [e.g. v14.2.22]
	**Additional context**
	Add any other context about the problem here.