Add feature request template

[jonathanperret]

As we request feedback on 1.0, some users are bound to have feature requests in mind. But currently, any issue on this repository has to be submitted as a bug report.

To avoid having to sort bug reports from feature requests after they are filed, it seems prudent to offer a way to submit feature requests.

The feature request template in this PR is derived from the default GitHub feature request template. I just put instructions into markdown comments as in #708 .

Summary by CodeRabbit

• New Features
  • Introduced a structured feature request template to streamline the submission process for users. This template guides users in providing detailed information about their requests, enhancing clarity and effectiveness in evaluations.

[coderabbitai]

Walkthrough

A new feature request template has been added to the project, located in the .github/ISSUE_TEMPLATE/feature_request.md file. This template is structured to guide users in submitting detailed feature requests, ensuring that all necessary information is provided for effective evaluation.

Changes

Files	Change Summary
.github/ISSUE_TEMPLATE/feature_request.md	Added a new feature request template to facilitate user submissions.

Possibly related PRs

• Copy issue template and contribution guide from main branch #676: This PR involves the introduction of issue templates, similar to the feature request template added in the main PR, indicating a focus on improving the issue submission process in the project.

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 7568ae7.

Files selected for processing (1)

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

Additional comments not posted (4)

.github/ISSUE_TEMPLATE/feature_request.md (4)

1-8: LGTM!

The header section is well-structured and includes relevant metadata. The "[FEATURE]" prefix in the title is a good way to clearly identify feature requests.

---

10-11: LGTM!

The "problem description" section includes a clear prompt and a helpful example to guide users in providing a concise description of the problem their feature aims to solve.

---

13-14: LGTM!

The "solution description" section includes a clear prompt and a helpful comment to guide users in providing a concise description of their desired solution.

---

16-20: LGTM!

The "alternatives" and "additional context" sections include clear prompts and helpful comments to guide users in providing concise descriptions of alternative solutions and any other relevant context. The "additional context" section is particularly useful for users to provide screenshots or other supporting information for their feature requests.

---

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.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud