-
Notifications
You must be signed in to change notification settings - Fork 50
docs: add issue and PR templates, github star trend #3
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
Conversation
Summary of ChangesHello @Kanaricc, 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 introduces a set of standardized GitHub issue and pull request templates to the repository. The primary goal is to enhance the quality and consistency of contributions by guiding users and developers to provide comprehensive information when reporting issues or submitting code changes. This will streamline the review process and improve overall project maintainability. 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 introduces a set of GitHub templates for issues and pull requests, which is a great step towards standardizing contributions. My review focuses on improving the clarity, usability, and formatting of these templates. I've suggested using standard Markdown for emphasis, making placeholder text more descriptive and helpful, restructuring the bug report template for better information gathering, and adhering to common file formatting conventions.
|
|
||
|
|
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.
This custom issue template is currently empty, which doesn't provide guidance to the user. To make it useful, you should add some basic structure. Adding sections like 'Problem Description' and 'Additional Context' will help users file more effective issues.
| ### Describe the issue | |
| A clear and concise description of your issue. | |
| ### Additional context | |
| Add any other context or screenshots about the problem here. |
| --- | ||
| name: Bug Report | ||
| about: Create a report to help us improve | ||
| title: '[Bug]:' |
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.
|
|
||
| --- | ||
|
|
||
| **<u>AgentEvolver is an open-source project. To involve a broader community, we recommend asking your questions in English.</u>** |
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 <u> HTML tag is used for underlining. In Markdown, it's more conventional and accessible to use bold (**...**) for emphasis. Underlined text is often mistaken for a hyperlink, which can be confusing for users.
| **<u>AgentEvolver is an open-source project. To involve a broader community, we recommend asking your questions in English.</u>** | |
| **AgentEvolver is an open-source project. To involve a broader community, we recommend asking your questions in English.** |
| **To Reproduce** | ||
| Steps to reproduce the behavior: | ||
|
|
||
| 1. You code | ||
| 2. How to execute | ||
| 3. See error | ||
|
|
||
| **Expected behavior** | ||
| A clear and concise description of what you expected to happen. | ||
|
|
||
| **Error messages** | ||
| Detailed error messages. |
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 'To Reproduce' and 'Error messages' sections can be improved to better guide users. By combining them and providing structured placeholders for code, commands, and error output, you can encourage more complete and actionable bug reports. This will make it easier to reproduce and fix bugs.
| **To Reproduce** | |
| Steps to reproduce the behavior: | |
| 1. You code | |
| 2. How to execute | |
| 3. See error | |
| **Expected behavior** | |
| A clear and concise description of what you expected to happen. | |
| **Error messages** | |
| Detailed error messages. | |
| **To Reproduce** | |
| Steps to reproduce the behavior. Please provide a minimal, reproducible example. | |
| 1. **Code that produces the error** | |
| ```python | |
| # Your code here | |
| ``` | |
| 2. **Commands to run** | |
| ```bash | |
| # Your commands here | |
| ``` | |
| 3. **Full error message** | |
| ```text | |
| # Paste the full error message or stack trace here | |
| ``` | |
| **Expected behavior** | |
| A clear and concise description of what you expected to happen. |
| @@ -0,0 +1,13 @@ | |||
| --- | |||
| name: Custom issue template | |||
| about: Describe this issue template's purpose here. | |||
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 about description is a placeholder. It should be updated to clearly describe the purpose of this issue template to users, for example, 'For issues that don't fit into other categories'.
| about: Describe this issue template's purpose here. | |
| about: Use this for issues that don't fit other templates. |
|
|
||
| --- | ||
|
|
||
| **<u>AgentEvolver is an open-source project. To involve a broader community, we recommend asking your questions in English.</u>** |
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 <u> HTML tag is used for underlining. In Markdown, it's more conventional and accessible to use bold (**...**) for emphasis. Underlined text is often mistaken for a hyperlink, which can be confusing for users.
| **<u>AgentEvolver is an open-source project. To involve a broader community, we recommend asking your questions in English.</u>** | |
| **AgentEvolver is an open-source project. To involve a broader community, we recommend asking your questions in English.** |
|
|
||
| --- | ||
|
|
||
| **<u>AgentEvolver is an open-source project. To involve a broader community, we recommend asking your questions in English.</u>** |
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 <u> HTML tag is used for underlining. In Markdown, it's more conventional and accessible to use bold (**...**) for emphasis. Underlined text is often mistaken for a hyperlink, which can be confusing for users.
| **<u>AgentEvolver is an open-source project. To involve a broader community, we recommend asking your questions in English.</u>** | |
| **AgentEvolver is an open-source project. To involve a broader community, we recommend asking your questions in English.** |
| A clear and concise description of any alternative solutions or features you've considered. | ||
|
|
||
| **Additional context** | ||
| Add any other context or screenshots about the feature request here. No newline at end of file |
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.
| - [ ] All tests are passing | ||
| - [ ] Docstrings are in Google style | ||
| - [ ] Related documentation has been updated (e.g. links, examples, etc.) | ||
| - [ ] Code is ready for review No newline at end of file |
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.
YunpengZhai
left a comment
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.
approved
Description
Checklist
Please check the following items before code is ready to be reviewed.