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

Add issue types to issue templates #5892

Merged
merged 2 commits into from
Oct 24, 2024
Merged

Add issue types to issue templates #5892

merged 2 commits into from
Oct 24, 2024

Conversation

bmesuere
Copy link
Member

This pull request adds issue types to the issue templates.

@bmesuere bmesuere added the chore Repository/build/dependency maintenance label Oct 24, 2024
@bmesuere bmesuere added the no deploy Prevents automatic deploy after merging label Oct 24, 2024
@bmesuere bmesuere enabled auto-merge October 24, 2024 11:50
Copy link
Contributor

coderabbitai bot commented Oct 24, 2024

Walkthrough

The changes involve modifications to the metadata of two issue templates in the GitHub repository. Specifically, the label key has been updated from "labels" to "type" in both the bug report and feature request templates. This change alters how issues are categorized within the repository's issue tracking system, transitioning from a label-based classification to a type-based classification.

Changes

File Change Summary
.github/ISSUE_TEMPLATE/bug_report.md Changed labels: bug to type: bug
.github/ISSUE_TEMPLATE/feature_request.md Changed labels to type

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between c37cb00 and 7b5f09a.

📒 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 (2)
.github/ISSUE_TEMPLATE/bug_report.md (2)

5-5: LGTM! The change aligns with GitHub's issue form schema

The change from labels to type is valid and follows GitHub's issue template schema. This modification will help in better categorizing issues while maintaining the same functionality.


5-5: Verify GitHub issue template compatibility

Let's verify if the type field is supported in GitHub issue templates.

✅ Verification successful

Let me try another verification approach by checking the existing issue templates and their structure.


Let me try one final verification approach to check the exact directory structure and files.


The type field is correctly used in both issue templates

The verification shows that both issue templates (bug_report.md and feature_request.md) consistently use the type field in their frontmatter:

  • bug_report.md uses type: bug
  • feature_request.md uses type: feature

This consistent usage across templates indicates a deliberate pattern for categorizing issues. The change aligns with the repository's issue management strategy.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if other repositories use the 'type' field in their issue templates
# and verify this is a supported GitHub feature

# Search for other issue templates using the 'type' field
rg -g "ISSUE_TEMPLATE/*.md" -l "^type: "

# Also check for any documentation files that might explain the template structure
fd -g "*.md" -x rg -l "issue.*template.*type"

Length of output: 239


Script:

#!/bin/bash
# Check all issue templates in the repository
fd -e md -p "ISSUE_TEMPLATE" --exec cat {}

# Also check if there are any yaml/yml issue templates
fd -e yaml -e yml -p "ISSUE_TEMPLATE" --exec cat {}

Length of output: 98


Script:

#!/bin/bash
# List all files in .github directory recursively
ls -R .github/

# Try to directly read the bug report template
cat .github/ISSUE_TEMPLATE/bug_report.md

# Try to directly read the feature request template mentioned in the AI summary
cat .github/ISSUE_TEMPLATE/feature_request.md

Length of output: 1207


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.

@bmesuere bmesuere merged commit e0a056a into main Oct 24, 2024
15 of 16 checks passed
@bmesuere bmesuere deleted the add-issue-types branch October 24, 2024 14:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Repository/build/dependency maintenance no deploy Prevents automatic deploy after merging
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants