Skip to content

Conversation

@Kanaricc
Copy link
Collaborator

@Kanaricc Kanaricc commented Nov 15, 2025

Description

  • add issue and PR templates
  • remove unused docs
  • add github star trend in README

Checklist

Please check the following items before code is ready to be reviewed.

  • All tests are passing
  • Docstrings are in Google style
  • Related documentation has been updated (e.g. links, examples, etc.)
  • Code is ready for review

@gemini-code-assist
Copy link

Summary of Changes

Hello @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

  • New Bug Report Template: Introduced a new template for bug reports, guiding users to provide essential information such as reproduction steps, expected behavior, error messages, and environment details.
  • New Feature Request Template: Added a template for feature requests, prompting users to describe the problem, desired solution, alternatives considered, and any additional context.
  • New Custom Issue Template: Included a generic custom issue template for other types of issues, allowing for flexibility in reporting.
  • New Pull Request Template: Implemented a pull request template that includes sections for description and a checklist to ensure code readiness before review, covering tests, docstrings, and documentation.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@Kanaricc Kanaricc requested a review from YunpengZhai November 15, 2025 03:04
@Kanaricc Kanaricc self-assigned this Nov 15, 2025
Copy link

@gemini-code-assist gemini-code-assist bot left a 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.

Comment on lines +12 to +13


Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

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.

Suggested change
### 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]:'

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

To improve readability and user experience, it's a good practice to add a space after the colon in the issue title prefix. This allows users to start typing their title immediately without having to add a space themselves.

Suggested change
title: '[Bug]:'
title: '[Bug]: '


---

**<u>AgentEvolver is an open-source project. To involve a broader community, we recommend asking your questions in English.</u>**

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

Suggested change
**<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.**

Comment on lines +15 to +26
**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.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

Suggested change
**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.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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'.

Suggested change
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>**

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

Suggested change
**<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>**

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

Suggested change
**<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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This file is missing a final newline. It's a common convention to end files with a single newline character. This ensures file integrity and proper handling by various command-line tools.

- [ ] 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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This file is missing a final newline. It's a common convention to end files with a single newline character. This ensures file integrity and proper handling by various command-line tools.

@Kanaricc Kanaricc changed the title docs: add GitHub issue and PR templates docs: add issue and PR templates, github star trend Nov 21, 2025
Copy link
Collaborator

@YunpengZhai YunpengZhai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

approved

@YunpengZhai YunpengZhai merged commit 4529852 into modelscope:main Nov 21, 2025
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.

2 participants