Skip to content

Commit 180c17c

Browse files
jackgerritsekzhu
andauthored
Update issue templates (#3610)
* Update config.yml * Delete .github/ISSUE_TEMPLATE.md * Delete .github/ISSUE_TEMPLATE/general_issue.yml * Update feature_request.yml * Update feature_request.yml * Update feature_request.yml * Update feature_request.yml * Update bug_report.yml * Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: Eric Zhu <[email protected]> * Update .github/ISSUE_TEMPLATE/config.yml Co-authored-by: Eric Zhu <[email protected]> * Update bug_report.yml * Update config.yml --------- Co-authored-by: Eric Zhu <[email protected]>
1 parent d4a0993 commit 180c17c

File tree

5 files changed

+54
-154
lines changed

5 files changed

+54
-154
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 0 additions & 57 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 41 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,55 @@
11
name: Bug Report
2-
description: File a bug report
3-
title: "[Bug]: "
2+
description: Report a bug
43
labels: ["bug"]
54

65
body:
76
- type: textarea
8-
id: description
97
attributes:
10-
label: Describe the bug
11-
description: A clear and concise description of what the bug is.
12-
placeholder: What went wrong?
8+
label: What happened?
9+
description: Please provide as much information as possible, this helps us address the issue.
10+
validations:
11+
required: true
1312
- type: textarea
14-
id: reproduce
1513
attributes:
16-
label: Steps to reproduce
17-
description: |
18-
Steps to reproduce the behavior:
19-
20-
1. Step 1
21-
2. Step 2
22-
3. ...
23-
4. See error
24-
placeholder: How can we replicate the issue?
14+
label: What did you expect to happen?
15+
validations:
16+
required: true
2517
- type: textarea
26-
id: modelused
2718
attributes:
28-
label: Model Used
29-
description: A description of the model that was used when the error was encountered
19+
label: How can we reproduce it (as minimally and precisely as possible)?
20+
description: Please provide steps to reproduce. Provide code that can be run if possible.
21+
validations:
22+
required: true
23+
- type: input
24+
attributes:
25+
label: AutoGen version
26+
description: What version or commit of the library was used
27+
validations:
28+
required: true
29+
- type: dropdown
30+
attributes:
31+
label: Which package was this bug in
32+
options:
33+
- Core
34+
- AgentChat
35+
- Extensions
36+
- AutoGen Studio
37+
- Magentic One
38+
- AutoGen Bench
39+
- Other
40+
validations:
41+
required: true
42+
- type: input
43+
attributes:
44+
label: Model used
45+
description: If a model was used, please describe it here, indicating whether it is a local model or a cloud-hosted model
3046
placeholder: gpt-4, mistral-7B etc
31-
- type: textarea
32-
id: expected_behavior
47+
- type: input
3348
attributes:
34-
label: Expected Behavior
35-
description: A clear and concise description of what you expected to happen.
36-
placeholder: What should have happened?
37-
- type: textarea
38-
id: screenshots
49+
label: Python version
50+
- type: input
3951
attributes:
40-
label: Screenshots and logs
41-
description: If applicable, add screenshots and logs to help explain your problem.
42-
placeholder: Add screenshots here
52+
label: Operating system
4353
- type: textarea
44-
id: additional_information
45-
attributes:
46-
label: Additional Information
47-
description: |
48-
- AutoGen Version: <!-- Specify the AutoGen version (e.g., v0.2.0) -->
49-
- Operating System: <!-- Specify the OS (e.g., Windows 10, Ubuntu 20.04) -->
50-
- Python Version: <!-- Specify the Python version (e.g., 3.8) -->
51-
- Related Issues: <!-- Link to any related issues here (e.g., #1) -->
52-
- Any other relevant information.
53-
placeholder: Any additional details
54+
attributes:
55+
label: Any additional info you think would be helpful for fixing this bug

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
11
blank_issues_enabled: true
2+
contact_links:
3+
- name: Questions or general help 💬
4+
url: https://github.com/microsoft/autogen/discussions
5+
about: Please ask and answer questions here.
Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,18 @@
11
name: Feature Request
2-
description: File a feature request
2+
description: Request a new feature or enhancement
33
labels: ["enhancement"]
4-
title: "[Feature Request]: "
54

65
body:
76
- type: textarea
8-
id: problem_description
97
attributes:
10-
label: Is your feature request related to a problem? Please describe.
11-
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12-
placeholder: What problem are you trying to solve?
8+
label: What feature would you like to be added?
9+
description: Please describe the desired feature. Be descriptive, provide examples and if possible, provide a proposed solution.
10+
validations:
11+
required: true
1312

1413
- type: textarea
15-
id: solution_description
1614
attributes:
17-
label: Describe the solution you'd like
18-
description: A clear and concise description of what you want to happen.
19-
placeholder: How do you envision the solution?
20-
21-
- type: textarea
22-
id: additional_context
23-
attributes:
24-
label: Additional context
25-
description: Add any other context or screenshots about the feature request here.
26-
placeholder: Any additional information
15+
label: Why is this needed?
16+
description: Why is it important that this feature is implemented? What problem or need does it solve?
17+
validations:
18+
required: true

.github/ISSUE_TEMPLATE/general_issue.yml

Lines changed: 0 additions & 41 deletions
This file was deleted.

0 commit comments

Comments
 (0)