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: update issue template #2624

Merged
merged 5 commits into from
May 24, 2024
Merged

Conversation

RubuJam
Copy link
Contributor

@RubuJam RubuJam commented May 23, 2024

💻 变更类型 | Change Type

  • ✨ feat
  • 🐛 fix
  • ♻️ refactor
  • 💄 style
  • 🔨 chore
  • ⚡️ perf
  • 📝 docs

🔀 变更说明 | Description of Change

更新问题模板
添加环境变量中ENABLED_OPENAIENABLED_OLLAMA的介绍

Update issue template
Add introduction to ENABLED_OPENAI and ENABLED_OLLAMA in environment variables

📝 补充信息 | Additional Information

close: #2618

Copy link

vercel bot commented May 23, 2024

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

A member of the Team first needs to authorize it.

@lobehubbot
Copy link
Member

👍 @RubuJam

Thank you for raising your pull request and contributing to our Community
Please make sure you have followed our contributing guidelines. We will review it as soon as possible.
If you encounter any problems, please feel free to connect with us.
非常感谢您提出拉取请求并为我们的社区做出贡献,请确保您已经遵循了我们的贡献指南,我们会尽快审查它。
如果您遇到任何问题,请随时与我们联系。

Copy link

codecov bot commented May 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.68%. Comparing base (ab4216e) to head (1c1fec2).
Report is 1 commits behind head on main.

Current head 1c1fec2 differs from pull request most recent head 77dd367

Please upload reports for the commit 77dd367 to get more accurate results.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2624   +/-   ##
=======================================
  Coverage   93.68%   93.68%           
=======================================
  Files         349      349           
  Lines       20408    20408           
  Branches     1574     1575    +1     
=======================================
  Hits        19119    19119           
  Misses       1289     1289           

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

Copy link

coderabbitai bot commented May 24, 2024

Walkthrough

The recent updates enhance our GitHub issue templates and self-hosting documentation. For bug reports, new fields and dropdown options have been added to better capture environment, version, and expected behavior details. In the self-hosting documentation, new environment variables for enabling or disabling OpenAI and Ollama model providers have been introduced, offering more control over model provider configurations.

Changes

Files Change Summaries
.github/ISSUE_TEMPLATE/1_bug_report.yml Added dropdown for environment selection, version input field, updated options for OS and browser dropdowns, and revised descriptions for bug and expected behavior fields.
.github/ISSUE_TEMPLATE/1_bug_report_cn.yml Adjusted labels and options for deployment environment, system environment, and browser dropdowns; added a version input field.
docs/self-hosting/environment-variables/model-provider.mdx Introduced environment variables ENABLED_OPENAI and ENABLED_OLLAMA with details on their types, descriptions, defaults, and examples.

🐇
In fields of code, changes flow,
Dropdowns set and inputs show.
Bugs described with care and might,
Environments clear, versions bright.
Models toggle, docs explain,
Flexibility we gain.
🌟

Tip

New Features and Improvements

Review Settings

Introduced new personality profiles for code reviews. Users can now select between "Chill" and "Assertive" review tones to tailor feedback styles according to their preferences. The "Assertive" profile posts more comments and nitpicks the code more aggressively, while the "Chill" profile is more relaxed and posts fewer comments.

AST-based Instructions

CodeRabbit offers customizing reviews based on the Abstract Syntax Tree (AST) pattern matching. Read more about AST-based instructions in the documentation.

Community-driven AST-based Rules

We are kicking off a community-driven initiative to create and share AST-based rules. Users can now contribute their AST-based rules to detect security vulnerabilities, code smells, and anti-patterns. Please see the ast-grep-essentials repository for more information.

New Static Analysis Tools

We are continually expanding our support for static analysis tools. We have added support for biome, hadolint, and ast-grep. Update the settings in your .coderabbit.yaml file or head over to the settings page to enable or disable the tools you want to use.

Tone Settings

Users can now customize CodeRabbit to review code in the style of their favorite characters or personalities. Here are some of our favorite examples:

  • Mr. T: "You must talk like Mr. T in all your code reviews. I pity the fool who doesn't!"
  • Pirate: "Arr, matey! Ye must talk like a pirate in all yer code reviews. Yarrr!"
  • Snarky: "You must be snarky in all your code reviews. Snark, snark, snark!"

Revamped Settings Page

We have redesigned the settings page for a more intuitive layout, enabling users to find and adjust settings quickly. This change was long overdue; it not only improves the user experience but also allows our development team to add more settings in the future with ease. Going forward, the changes to .coderabbit.yaml will be reflected in the settings page, and vice versa.

Miscellaneous

  • Turn off free summarization: You can switch off free summarization of PRs opened by users not on a paid plan using the enable_free_tier setting.
  • Knowledge-base scope: You can now set the scope of the knowledge base to either the repository (local) or the organization (global) level using the knowledge_base setting. In addition, you can specify Jira project keys and Linear team keys to limit the knowledge base scope for those integrations.
  • High-level summary placement: You can now customize the location of the high-level summary in the PR description using the high_level_summary_placeholder setting (default @coderabbitai summary).
  • Revamped request changes workflow: You can now configure CodeRabbit to auto-approve or request changes on PRs based on the review feedback using the request_changes_workflow setting.

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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 73989e7 and 77dd367.
Files selected for processing (4)
  • .github/ISSUE_TEMPLATE/1_bug_report.yml (3 hunks)
  • .github/ISSUE_TEMPLATE/1_bug_report_cn.yml (2 hunks)
  • docs/self-hosting/environment-variables/model-provider.mdx (2 hunks)
  • docs/self-hosting/environment-variables/model-provider.zh-CN.mdx (2 hunks)
Files skipped from review due to trivial changes (2)
  • .github/ISSUE_TEMPLATE/1_bug_report_cn.yml
  • docs/self-hosting/environment-variables/model-provider.zh-CN.mdx
Additional comments not posted (8)
.github/ISSUE_TEMPLATE/1_bug_report.yml (6)

6-17: Ensure the 'Environment' dropdown is comprehensive and aligns with the platforms your application supports.


18-22: Adding a 'Version' input field is a good practice for bug tracking. Ensure it is clearly communicated to users how they should format their version input.


28-28: The 'Unselected' option is a good default choice for the 'Operating System' dropdown to ensure users actively select an option.


42-42: The 'Unselected' option in the 'Browser' dropdown follows the same good practice as the 'Operating System' dropdown.


53-53: The updated description for the 'Bug Description' field is clear and encourages detailed bug reports.


60-63: The addition of an 'Expected Behavior' field is beneficial for understanding user expectations and should help in reproducing and resolving issues more effectively.

docs/self-hosting/environment-variables/model-provider.mdx (2)

18-23: The addition of the ENABLED_OPENAI environment variable is crucial for flexibility in service configuration. Ensure that the documentation is clear on how setting this variable to 0 affects the system.


199-204: Similarly, the ENABLED_OLLAMA variable adds important configurability for using Ollama as a model provider. It's good to see consistency in the approach to enabling/disabling services.

@arvinxx arvinxx merged commit 634870a into lobehub:main May 24, 2024
1 of 3 checks passed
@lobehubbot
Copy link
Member

❤️ Great PR @RubuJam ❤️

The growth of project is inseparable from user feedback and contribution, thanks for your contribution! If you are interesting with the lobehub developer community, please join our discord and then dm @arvinxx or @canisminor1990. They will invite you to our private developer channel. We are talking about the lobe-chat development or sharing ai newsletter around the world.
项目的成长离不开用户反馈和贡献,感谢您的贡献! 如果您对 LobeHub 开发者社区感兴趣,请加入我们的 discord,然后私信 @arvinxx@canisminor1990。他们会邀请您加入我们的私密开发者频道。我们将会讨论关于 Lobe Chat 的开发,分享和讨论全球范围内的 AI 消息。

@lobehubbot
Copy link
Member

🎉 This PR is included in version 0.161.13 🎉

The release is available on:

Your semantic-release bot 📦🚀

@RubuJam RubuJam deleted the ISSUE_TEMPLATE branch May 24, 2024 09:17
ipoly pushed a commit to ipoly/lobe-chat that referenced this pull request Jul 29, 2024
* 🔨 chore: update issue template

* 🔨 chore: update issue template

* 📝 docs: Add introduction to `ENABLED_OPENAI` and `ENABLED_OLLAMA`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug] 最新版ollama又默认开出来了
3 participants