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 chinese template #4984

Merged
merged 3 commits into from
Jul 15, 2024
Merged

chore: add chinese template #4984

merged 3 commits into from
Jul 15, 2024

Conversation

RubuJam
Copy link
Contributor

@RubuJam RubuJam commented Jul 12, 2024

引入PR模板
修改问题报告功能请求模板
添加问题报告功能请求中文模版

Introduce PR template
Modify Issues Report and Feature Request templates
Add Chinese templates for Issues Report and Feature Request

Summary by CodeRabbit

  • New Features
    • Introduced new templates for bug reports, feature requests, and pull request descriptions to streamline issue and pull request submissions.
    • Added Chinese versions of bug report and feature request templates to support Chinese-speaking users.

Copy link

vercel bot commented Jul 12, 2024

@RubuJam is attempting to deploy a commit to the NextChat Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Jul 12, 2024

Walkthrough

The changes introduce new templates for GitHub issue reports and pull requests. Specific templates are created for bug reports and feature requests, available in both English and Chinese. These templates standardize the information that users need to provide, enhancing clarity and consistency in issue and feature request submissions.

Changes

Files Change Summary
.github/ISSUE_TEMPLATE/1_bug_report.yml Introduces a bug report template with fields for deployment method, version, OS, system version, browser, etc.
.github/ISSUE_TEMPLATE/1_bug_report_cn.yml Adds a Chinese bug report template with fields for deployment method, version, OS, system version, browser, etc.
.github/ISSUE_TEMPLATE/2_feature_request.yml Introduces a feature request template with fields for feature description, proposed solution, and additional info.
.github/ISSUE_TEMPLATE/2_feature_request_cn.yml Adds a Chinese feature request template with fields for description, title, labels, and supplementary information.
.github/PULL_REQUEST_TEMPLATE.md Introduces a pull request template for categorizing changes, describing them, and providing additional information.

Poem

With templates new, the code will flow,
Bugs and features, we now bestow.
Clear and bright, in lines they stand,
In English or Chinese, hand in hand.
With every pull, our project grows,
In harmony, the workflow goes. 🌟


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.

@lloydzhou lloydzhou added the enhancement New feature or request label Jul 12, 2024
Copy link
Contributor

@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 89049e1 and 30ca211.

Files selected for processing (5)
  • .github/ISSUE_TEMPLATE/1_bug_report.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/1_bug_report_cn.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/2_feature_request.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/2_feature_request_cn.yml (1 hunks)
  • .github/PULL_REQUEST_TEMPLATE.md (1 hunks)
Files skipped from review due to trivial changes (3)
  • .github/ISSUE_TEMPLATE/2_feature_request.yml
  • .github/ISSUE_TEMPLATE/2_feature_request_cn.yml
  • .github/PULL_REQUEST_TEMPLATE.md
Additional comments not posted (22)
.github/ISSUE_TEMPLATE/1_bug_report_cn.yml (11)

1-4: Template Metadata: Looks Good

The name, description, title, and labels fields are correctly defined and provide a clear indication of the purpose of the template.


6-19: Dropdown for Deployment Method: Comprehensive Options

The dropdown for deployment method includes a comprehensive list of options, covering most common methods.


20-24: Input for Software Version: Mandatory Field

The input field for software version is correctly marked as required.


26-40: Dropdown for System Environment: Comprehensive Options

The dropdown for system environment includes a comprehensive list of options, covering most common systems.


41-45: Input for System Version: Mandatory Field

The input field for system version is correctly marked as required.


47-57: Dropdown for Browser: Comprehensive Options

The dropdown for browser includes a comprehensive list of options, covering most common browsers.


58-62: Input for Browser Version: Mandatory Field

The input field for browser version is correctly marked as required.


63-68: Textarea for Issue Description: Clear Instructions

The textarea for issue description provides clear instructions for the user.


69-73: Textarea for Reproduction Steps: Clear Instructions

The textarea for reproduction steps provides clear instructions for the user.


74-77: Textarea for Expected Result: Clear Instructions

The textarea for expected result provides clear instructions for the user.


78-80: Textarea for Additional Information: Clear Instructions

The textarea for additional information provides clear instructions for the user.

.github/ISSUE_TEMPLATE/1_bug_report.yml (11)

1-4: Template Metadata: Looks Good

The name, description, title, and labels fields are correctly defined and provide a clear indication of the purpose of the template.


6-19: Dropdown for Deployment Method: Comprehensive Options

The dropdown for deployment method includes a comprehensive list of options, covering most common methods.


20-24: Input for Version: Mandatory Field

The input field for version is correctly marked as required.


26-40: Dropdown for Operating System: Comprehensive Options

The dropdown for operating system includes a comprehensive list of options, covering most common systems.


41-45: Input for System Version: Mandatory Field

The input field for system version is correctly marked as required.


47-57: Dropdown for Browser: Comprehensive Options

The dropdown for browser includes a comprehensive list of options, covering most common browsers.


58-62: Input for Browser Version: Mandatory Field

The input field for browser version is correctly marked as required.


63-68: Textarea for Bug Description: Clear Instructions

The textarea for bug description provides clear instructions for the user.


69-73: Textarea for Recurrence Steps: Clear Instructions

The textarea for recurrence steps provides clear instructions for the user.


74-77: Textarea for Expected Behavior: Clear Instructions

The textarea for expected behavior provides clear instructions for the user.


78-80: Textarea for Additional Information: Clear Instructions

The textarea for additional information provides clear instructions for the user.

@lloydzhou
Copy link
Contributor

新增中文模板的时候,是不是应该新加一个相同结构的yml,而不是把旧模板结构也改变了?

@Issues-translate-bot
Copy link

Bot detected the issue body's language is not English, translate it automatically.


When adding a new Chinese template, should I add a new yml with the same structure instead of changing the old template structure?

@lloydzhou lloydzhou added the question Further information is requested label Jul 12, 2024
@RubuJam
Copy link
Contributor Author

RubuJam commented Jul 12, 2024

我个人倾向于彻底重写整个模板,原有的感觉过于繁杂

已将titlelabels恢复至原样

新增中文模板的时候,是不是应该新加一个相同结构的yml,而不是把旧模板结构也改变了?

@Issues-translate-bot
Copy link

Bot detected the issue body's language is not English, translate it automatically.


Personally, I prefer to completely rewrite the entire template. The original one feels too complicated.

When adding a new Chinese template, should I add a new yml with the same structure instead of changing the old template structure?

Copy link
Contributor

@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 30ca211 and a0290b0.

Files selected for processing (4)
  • .github/ISSUE_TEMPLATE/1_bug_report.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/1_bug_report_cn.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/2_feature_request.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/2_feature_request_cn.yml (1 hunks)
Files skipped from review as they are similar to previous changes (4)
  • .github/ISSUE_TEMPLATE/1_bug_report.yml
  • .github/ISSUE_TEMPLATE/1_bug_report_cn.yml
  • .github/ISSUE_TEMPLATE/2_feature_request.yml
  • .github/ISSUE_TEMPLATE/2_feature_request_cn.yml

Copy link
Contributor

Your build has completed!

Preview deployment

@Dogtiti Dogtiti merged commit 1779f1f into ChatGPTNextWeb:main Jul 15, 2024
1 of 2 checks passed
@RubuJam RubuJam deleted the chore/pr branch July 15, 2024 04:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request question Further information is requested
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants