Skip to content

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Nov 21, 2025
Merged

docs: add issue and PR templates, github star trend #3

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
334fe28
docs: add GitHub issue and PR templates
Kanaricc Nov 15, 2025
e73c554
chore: clear doc
Kanaricc Nov 18, 2025
447a3dc
docs: add star trend
Kanaricc Nov 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: Bug Report
about: Create a report to help us improve
title: '[Bug]:'
Copy link

@gemini-code-assist gemini-code-assist bot Nov 15, 2025

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]: '

labels: 'bug'
assignees: ''

---

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

@gemini-code-assist gemini-code-assist bot Nov 15, 2025

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


**Describe the bug**
A clear and concise description of what the bug is.

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

@gemini-code-assist gemini-code-assist bot Nov 15, 2025

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.


**Environment (please complete the following information):**

- Python Version: [e.g. 3.10]
- CUDA Version: [e.g. 11.7]
- OS: [e.g. macos, windows]

**Additional context**
Add any other context about the problem here.
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/custom.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
name: Custom issue template
about: Describe this issue template's purpose here.
Copy link

@gemini-code-assist gemini-code-assist bot Nov 15, 2025

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.

title: ''
labels: ''
assignees: ''

---

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

@gemini-code-assist gemini-code-assist bot Nov 15, 2025

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 +12 to +13
Copy link

@gemini-code-assist gemini-code-assist bot Nov 15, 2025

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.

23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Feature Request
about: Suggest an idea for this project
title: '[Feature]: '
labels: 'enhancement'
assignees: ''

---

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

@gemini-code-assist gemini-code-assist bot Nov 15, 2025

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



**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
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.
Copy link

@gemini-code-assist gemini-code-assist bot Nov 15, 2025

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.

12 changes: 12 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
## Description

[Please describe the background, purpose, changes made, and how to test this PR]

## 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
Copy link

@gemini-code-assist gemini-code-assist bot Nov 15, 2025

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.