chore:add issue template
This PR fixes #80
Summary by CodeRabbit
-
New Features
- Introduced an issue template for reporting bugs or suggestions, making it easier to provide detailed information and streamline issue tracking.
- Enabled blank issues for more flexible issue reporting.
@uma-victor1 is attempting to deploy a commit to the Idris Olubisi 's projects Team on Vercel.
A member of the Team first needs to authorize it.
Walkthrough
The changes introduce a new configuration file and an issue template for the GitHub repository. The configuration enables blank issues, while the template guides users in providing detailed bug reports or suggestions, enhancing the issue submission process.
Changes
| File / Path | Summary |
|---|---|
| .github/ISSUE_TEMPLATE/config.yml | Introduced the configuration setting blank_issues_enabled: true |
| .github/.../ISSUE_TEMPLATE/issue.md | Added an issue template with sections for description, screenshots, relevant files/links, steps to reproduce, and specific tasks with checkboxes |
Assessment against linked issues
| Objective | Addressed | Explanation |
|---|---|---|
| Add an issue template for streamlined submission (#80) | ✅ |
Poem
A template now, for issues clear,
To guide our thoughts, our woes, and cheer.
With checkboxes and steps to show,
Our project's path will smoothly flow.
So here's a change, both neat and grand,
Let's celebrate with a rabbit's hand! 🐰🎉
[!TIP]
AI model upgrade
gpt-4omodel for reviews and chat is now liveOpenAI claims that this model is better at understanding and generating code than the previous models. Please join our Discord Community to provide any feedback or to report any issues.
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?
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
@coderabbitaiin 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
@coderabbitaiin 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 as PR comments)
-
@coderabbitai pauseto pause the reviews on a PR. -
@coderabbitai resumeto resume the paused reviews. -
@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository. -
@coderabbitai full reviewto do a full review from scratch and review all the files again. -
@coderabbitai summaryto regenerate the summary of the PR. -
@coderabbitai resolveresolve all the CodeRabbit review comments. -
@coderabbitai configurationto show the current CodeRabbit configuration for the repository. -
@coderabbitai helpto 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.yamlfile 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.
Hi @Olanetsoft,
Can you review this?