Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore:add issue template #81

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

uma-victor1
Copy link

@uma-victor1 uma-victor1 commented Jul 2, 2024

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.

Copy link

vercel bot commented Jul 2, 2024

@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.

Copy link

coderabbitai bot commented Jul 2, 2024

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-4o model for reviews and chat is now live

OpenAI 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?

Share
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 as 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.

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.
  • 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 164005d and ab9776b.

Files selected for processing (2)
  • .github/ISSUE_TEMPLATE/config.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/issue.md (1 hunks)
Files skipped from review due to trivial changes (2)
  • .github/ISSUE_TEMPLATE/config.yml
  • .github/ISSUE_TEMPLATE/issue.md

@uma-victor1
Copy link
Author

Hi @Olanetsoft,

Can you review this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

An issue template will be nice.
1 participant