-
Notifications
You must be signed in to change notification settings - Fork 1.1k
[docs]: add issue config #1621
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
[docs]: add issue config #1621
Conversation
Summary of ChangesHello @KMSorSMS, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request enhances the repository's issue management by adding a new issue configuration file. This change aims to streamline the issue reporting process by guiding users to existing resources, such as an FAQ, before they submit new issues, thereby improving the overall quality and efficiency of community support. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request adds a GitHub issue configuration file to guide users when creating new issues. My review focuses on improving the effectiveness of this configuration. I've suggested correcting the FAQ link to point to this repository's own FAQ and disabling blank issues to better direct users to the provided templates and resources. These changes should help achieve the PR's goal of making users more aware of the project's QA process.
.github/ISSUE_TEMPLATE/config.yml
Outdated
| blank_issues_enabled: true | ||
| contact_links: | ||
| - name: 📚 FAQs | 常见问题 | ||
| url: https://github.com/hiyouga/LLaMA-Factory/issues/4614 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The URL for the FAQ points to the LLaMA-Factory repository, which seems incorrect for this project (ktransformers). It should likely point to an FAQ relevant to this repository. Based on doc/en/FAQ.md, a more appropriate URL would be https://github.com/kvcache-ai/ktransformers/issues/1608.
url: https://github.com/kvcache-ai/ktransformers/issues/1608
.github/ISSUE_TEMPLATE/config.yml
Outdated
| @@ -0,0 +1,5 @@ | |||
| blank_issues_enabled: true | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To better guide users towards using issue templates and reading the FAQ as intended by this PR, consider disabling blank issues. This encourages users to select a specific template or follow the contact links provided, rather than opening an empty issue. This aligns with the goal of making users 'aware of the QA'.
blank_issues_enabled: falsea1918c0 to
589f459
Compare
What does this PR do?
Add issue config so that the user can be aware of the QA
Before submitting