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 and pull request templates for better contribution guidelines #1753

Merged
merged 1 commit into from
Jan 13, 2025

Conversation

sorrycc
Copy link
Member

@sorrycc sorrycc commented Jan 13, 2025

.

Summary by CodeRabbit

  • 新功能

    • 引入了新的 GitHub 问题和拉取请求模板
    • 添加了错误报告模板,帮助用户提供详细的问题描述
    • 添加了功能请求模板,方便用户提交新功能建议
    • 启用了创建空白问题的选项
  • 改进

    • 优化了问题和拉取请求提交流程
    • 为项目贡献者提供更清晰的指导和模板

@sorrycc sorrycc merged commit 23b7d34 into master Jan 13, 2025
2 checks passed
Copy link
Contributor

coderabbitai bot commented Jan 13, 2025

Caution

Review failed

The pull request is closed.

演练

这些更改引入了一系列 GitHub 问题和拉取请求模板,旨在改进项目的协作和问题报告流程。新模板包括错误报告、功能请求和拉取请求模板,每个模板都提供了结构化的表单,引导用户提供更详细、更有针对性的信息。这些模板将帮助项目维护者更有效地管理和理解社区反馈。

更改

文件 更改摘要
.github/ISSUE_TEMPLATE/bug_report.yml 新增错误报告模板,包含bug描述、重现步骤、日志、严重性和附加上下文的字段
.github/ISSUE_TEMPLATE/config.yml 启用空白问题创建
.github/ISSUE_TEMPLATE/feature_request.yml 新增功能请求模板,包含问题描述、解决方案、替代方案和重要性字段
.github/PULL_REQUEST_TEMPLATE.md 新增拉取请求模板,提供描述和检查清单

诗歌

🐰 代码兔子的模板之歌

问题模板闪耀光芒,
错误与特性皆有方向。
清晰明了,沟通无障,
协作之路更加宽广!
🐞✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 75ee67b and a2a9f76.

📒 Files selected for processing (4)
  • .github/ISSUE_TEMPLATE/bug_report.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/config.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/feature_request.yml (1 hunks)
  • .github/PULL_REQUEST_TEMPLATE.md (1 hunks)

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@sorrycc sorrycc deleted the sorrycc-gsod branch January 13, 2025 12:10
Copy link

Walkthrough

This pull request introduces new templates for issue and pull request submissions to enhance contribution guidelines. It includes templates for bug reports, feature requests, and a pull request checklist to ensure comprehensive submissions.

Changes

File Summary
.github/ISSUE_TEMPLATE/bug_report.yml Added a new template for bug reports with 43 lines of content.
.github/ISSUE_TEMPLATE/feature_request.yml Added a new template for feature requests with 44 lines of content.
.github/ISSUE_TEMPLATE/config.yml Added a configuration file for issue templates with 1 line of content.
.github/PULL_REQUEST_TEMPLATE.md Introduced a new pull request template with a checklist to guide contributors.

Copy link

codecov bot commented Jan 13, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 54.81%. Comparing base (75ee67b) to head (a2a9f76).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1753      +/-   ##
==========================================
- Coverage   54.82%   54.81%   -0.02%     
==========================================
  Files         180      180              
  Lines       18081    18081              
==========================================
- Hits         9913     9911       -2     
- Misses       8168     8170       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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.

1 participant