Skip to content

Commit 4ad866f

Browse files
authored
chore(template): add issue/PR templates (#125)
relate: #107
1 parent a6a149a commit 4ad866f

4 files changed

Lines changed: 88 additions & 0 deletions

File tree

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve
4+
title: '[Bug]:'
5+
labels: 'bug'
6+
assignees: ''
7+
8+
---
9+
10+
**<u>AgentScope-Java is an open-source project. To involve a broader community, we recommend asking your questions in English.</u>**
11+
12+
**Describe the bug**
13+
A clear and concise description of what the bug is.
14+
15+
**To Reproduce**
16+
Steps to reproduce the behavior:
17+
18+
1. You code
19+
2. How to execute
20+
3. See error
21+
22+
**Expected behavior**
23+
A clear and concise description of what you expected to happen.
24+
25+
**Error messages**
26+
Detailed error messages.
27+
28+
**Environment (please complete the following information):**
29+
30+
- AgentScope-Java Version: [e.g. 1.0.0, check your pom.xml dependency version or run `mvn dependency:tree | grep agentscope-parent:pom`(only mac/linux)]
31+
- Java Version: [e.g. 17]
32+
- OS: [e.g. macos, windows]
33+
34+
**Additional context**
35+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/custom.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
name: Custom issue template
3+
about: Describe this issue template's purpose here.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**<u>AgentScope-Java is an open-source project. To involve a broader community, we recommend asking your questions in English.</u>**
11+
12+
13+
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project
4+
title: '[Feature]: '
5+
labels: 'enhancement'
6+
assignees: ''
7+
8+
---
9+
10+
**<u>AgentScope-Java is an open-source project. To involve a broader community, we recommend asking your questions in English.</u>**
11+
12+
13+
**Is your feature request related to a problem? Please describe.**
14+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
15+
16+
**Describe the solution you'd like**
17+
A clear and concise description of what you want to happen.
18+
19+
**Describe alternatives you've considered**
20+
A clear and concise description of any alternative solutions or features you've considered.
21+
22+
**Additional context**
23+
Add any other context or screenshots about the feature request here.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
## AgentScope-Java Version
2+
3+
[The version of AgentScope-Java you are working on, e.g. 1.0.0, check your pom.xml dependency version or run `mvn dependency:tree | grep agentscope-parent:pom`(only mac/linux)]
4+
5+
## Description
6+
7+
[Please describe the background, purpose, changes made, and how to test this PR]
8+
9+
## Checklist
10+
11+
Please check the following items before code is ready to be reviewed.
12+
13+
- [ ] Code has been formatted with `mvn spotless:apply`
14+
- [ ] All tests are passing (`mvn test`)
15+
- [ ] Javadoc comments are complete and follow project conventions
16+
- [ ] Related documentation has been updated (e.g. links, examples, etc.)
17+
- [ ] Code is ready for review

0 commit comments

Comments
 (0)