Skip to content

Commit

Permalink
Update issue templates (#3610)
Browse files Browse the repository at this point in the history
* 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]>
  • Loading branch information
jackgerrits and ekzhu authored Oct 3, 2024
1 parent d4a0993 commit 180c17c
Show file tree
Hide file tree
Showing 5 changed files with 54 additions and 154 deletions.
57 changes: 0 additions & 57 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

80 changes: 41 additions & 39 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,53 +1,55 @@
name: Bug Report
description: File a bug report
title: "[Bug]: "
description: Report a bug
labels: ["bug"]

body:
- type: textarea
id: description
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
placeholder: What went wrong?
label: What happened?
description: Please provide as much information as possible, this helps us address the issue.
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: Steps to reproduce
description: |
Steps to reproduce the behavior:
1. Step 1
2. Step 2
3. ...
4. See error
placeholder: How can we replicate the issue?
label: What did you expect to happen?
validations:
required: true
- type: textarea
id: modelused
attributes:
label: Model Used
description: A description of the model that was used when the error was encountered
label: How can we reproduce it (as minimally and precisely as possible)?
description: Please provide steps to reproduce. Provide code that can be run if possible.
validations:
required: true
- type: input
attributes:
label: AutoGen version
description: What version or commit of the library was used
validations:
required: true
- type: dropdown
attributes:
label: Which package was this bug in
options:
- Core
- AgentChat
- Extensions
- AutoGen Studio
- Magentic One
- AutoGen Bench
- Other
validations:
required: true
- type: input
attributes:
label: Model used
description: If a model was used, please describe it here, indicating whether it is a local model or a cloud-hosted model
placeholder: gpt-4, mistral-7B etc
- type: textarea
id: expected_behavior
- type: input
attributes:
label: Expected Behavior
description: A clear and concise description of what you expected to happen.
placeholder: What should have happened?
- type: textarea
id: screenshots
label: Python version
- type: input
attributes:
label: Screenshots and logs
description: If applicable, add screenshots and logs to help explain your problem.
placeholder: Add screenshots here
label: Operating system
- type: textarea
id: additional_information
attributes:
label: Additional Information
description: |
- AutoGen Version: <!-- Specify the AutoGen version (e.g., v0.2.0) -->
- Operating System: <!-- Specify the OS (e.g., Windows 10, Ubuntu 20.04) -->
- Python Version: <!-- Specify the Python version (e.g., 3.8) -->
- Related Issues: <!-- Link to any related issues here (e.g., #1) -->
- Any other relevant information.
placeholder: Any additional details
attributes:
label: Any additional info you think would be helpful for fixing this bug
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Questions or general help 💬
url: https://github.com/microsoft/autogen/discussions
about: Please ask and answer questions here.
26 changes: 9 additions & 17 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,26 +1,18 @@
name: Feature Request
description: File a feature request
description: Request a new feature or enhancement
labels: ["enhancement"]
title: "[Feature Request]: "

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

- type: textarea
id: solution_description
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
placeholder: How do you envision the solution?

- type: textarea
id: additional_context
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
placeholder: Any additional information
label: Why is this needed?
description: Why is it important that this feature is implemented? What problem or need does it solve?
validations:
required: true
41 changes: 0 additions & 41 deletions .github/ISSUE_TEMPLATE/general_issue.yml

This file was deleted.

0 comments on commit 180c17c

Please sign in to comment.