Skip to content

A programming framework for agentic AI

Update issue templates (#3610)

Jack Gerrits180c17c1f4b2
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
deleted file mode 100644
index b3b0d0dae..000000000
--- a/.github/ISSUE_TEMPLATE.md
+++ /dev/null
@@ -1,57 +0,0 @@
-### Description
-<!-- A clear and concise description of the issue or feature request. -->
-
-### Environment
-- AutoGen version: <!-- Specify the AutoGen version (e.g., v0.2.0) -->
-- Python version: <!-- Specify the Python version (e.g., 3.8) -->
-- Operating System: <!-- Specify the OS (e.g., Windows 10, Ubuntu 20.04) -->
-
-### Steps to Reproduce (for bugs)
-<!-- Provide detailed steps to reproduce the issue. Include code snippets, configuration files, or any other relevant information. -->
-
-1. Step 1
-2. Step 2
-3. ...
-
-### Expected Behavior
-<!-- Describe what you expected to happen. -->
-
-### Actual Behavior
-<!-- Describe what actually happened. Include any error messages, stack traces, or unexpected behavior. -->
-
-### Screenshots / Logs (if applicable)
-<!-- If relevant, include screenshots or logs that help illustrate the issue. -->
-
-### Additional Information
-<!-- Include any additional information that might be helpful, such as specific configurations, data samples, or context about the environment. -->
-
-### Possible Solution (if you have one)
-<!-- If you have suggestions on how to address the issue, provide them here. -->
-
-### Is this a Bug or Feature Request?
-<!-- Choose one: Bug | Feature Request -->
-
-### Priority
-<!-- Choose one: High | Medium | Low -->
-
-### Difficulty
-<!-- Choose one: Easy | Moderate | Hard -->
-
-### Any related issues?
-<!-- If this is related to another issue, reference it here. -->
-
-### Any relevant discussions?
-<!-- If there are any discussions or forum threads related to this issue, provide links. -->
-
-### Checklist
-<!-- Please check the items that you have completed -->
-- [ ] I have searched for similar issues and didn't find any duplicates.
-- [ ] I have provided a clear and concise description of the issue.
-- [ ] I have included the necessary environment details.
-- [ ] I have outlined the steps to reproduce the issue.
-- [ ] I have included any relevant logs or screenshots.
-- [ ] I have indicated whether this is a bug or a feature request.
-- [ ] I have set the priority and difficulty levels.
-
-### Additional Comments
-<!-- Any additional comments or context that you think would be helpful. -->
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index 434226b3e..090fa6cc5 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -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
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
index 0086358db..76afcbcc5 100644
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -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.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
index e8a63df7a..57f360761 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.yml
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -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
diff --git a/.github/ISSUE_TEMPLATE/general_issue.yml b/.github/ISSUE_TEMPLATE/general_issue.yml
deleted file mode 100644
index b585f4642..000000000
--- a/.github/ISSUE_TEMPLATE/general_issue.yml
+++ /dev/null
@@ -1,41 +0,0 @@
-name: General Issue
-description: File a general issue
-title: "[Issue]: "
-labels: []
-
-body:
- - type: textarea
- id: description
- attributes:
- label: Describe the issue
- description: A clear and concise description of what the issue is.
- placeholder: What went wrong?
- - 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?
- - type: textarea
- id: screenshots
- attributes:
- label: Screenshots and logs
- description: If applicable, add screenshots and logs to help explain your problem.
- placeholder: Add screenshots here
- - 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