Skip to content

A programming framework for agentic AI

Update issue templates (#5686)

Jack Gerritsa54a85e2f848
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/1-bug_report.yml
similarity index 98%
rename from .github/ISSUE_TEMPLATE/bug_report.yml
rename to .github/ISSUE_TEMPLATE/1-bug_report.yml
index 8feb83f98..7674be913 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/1-bug_report.yml
@@ -1,6 +1,8 @@
-name: Bug Report
+name: πŸ› Bug Report
description: Report a bug
type: "bug"
+labels:
+ - needs-triage
body:
- type: markdown
@@ -8,7 +10,7 @@ body:
value: |
## Please Read the following before submitting an issue.
- ### Have you read the doc?
+ ### Have you read the docs?
- [Python AgentChat User Guide and Tutorial](https://microsoft.github.io/autogen/stable/user-guide/agentchat-user-guide/index.html)
- [Python Core API User Guide](https://microsoft.github.io/autogen/stable/user-guide/core-user-guide/index.html)
- [Python API Doc](https://microsoft.github.io/autogen/stable/reference/index.html)
diff --git a/.github/ISSUE_TEMPLATE/2-doc_issue.yml b/.github/ISSUE_TEMPLATE/2-doc_issue.yml
new file mode 100644
index 000000000..d96f95f84
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/2-doc_issue.yml
@@ -0,0 +1,47 @@
+name: πŸ“˜ Doc Issue
+description: Report an issue in the documentation, including missing or incorrect information.
+type: "bug"
+labels:
+ - needs-triage
+ - documentation
+
+body:
+ - type: markdown
+ attributes:
+ value: |
+ ## Please Read the following before submitting an issue.
+
+ ### Have you read the docs?
+ - [Python AgentChat User Guide and Tutorial](https://microsoft.github.io/autogen/stable/user-guide/agentchat-user-guide/index.html)
+ - [Python Core API User Guide](https://microsoft.github.io/autogen/stable/user-guide/core-user-guide/index.html)
+ - [Python API Doc](https://microsoft.github.io/autogen/stable/reference/index.html)
+ - [.NET Doc](https://microsoft.github.io/autogen/dotnet/)
+
+ ### Have you searched for related issues?
+ - Some other users might have the same issue as yours.
+
+ - type: textarea
+ attributes:
+ label: What is the doc issue?
+ description: Please provide as much information as possible, this helps us address the issue. Use Markdown to format your text.
+ value: |
+ **Describe the issue**
+ A clear and concise description of what the issue is. What is missing or incorrect?
+
+ **What do you want to see in the doc?**
+
+ **Screenshots**
+ If applicable, add screenshots to help explain your problem.
+
+ **Additional context**
+ Add any other context about the problem here.
+ validations:
+ required: true
+ - type: input
+ id: doc-link
+ attributes:
+ label: Link to the doc page, if applicable
+ description: Please provide a link to the doc page that has the issue.
+ placeholder: https://microsoft.github.io/autogen/stable/user-guide/agentchat-user-guide/index.html
+ validations:
+ required: true
diff --git a/.github/ISSUE_TEMPLATE/3-maintainer_only.yml b/.github/ISSUE_TEMPLATE/3-maintainer_only.yml
new file mode 100644
index 000000000..e2d9a6125
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/3-maintainer_only.yml
@@ -0,0 +1,20 @@
+name: πŸ”’ Maintainer Only
+description: Only use this template if you are a maintainer.
+
+body:
+ - type: checkboxes
+ attributes:
+ label: Confirmation
+ description: Please only use this template if you are a maintainer. Thanks for helping us keep the issue tracker organized!
+ options:
+ - label: I confirm that I am a maintainer and so can use this template. If I am not, I understand this issue will be closed and I will be asked to use a different template.
+ required: true
+
+ - type: textarea
+ id: body
+ attributes:
+ label: Issue body
+ description: "How do you trigger this bug? Please walk us through it step by step."
+ validations:
+ required: true
+
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
index 76afcbcc5..12d93e88f 100644
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,5 +1,8 @@
-blank_issues_enabled: true
+blank_issues_enabled: false
contact_links:
- - name: Questions or general help πŸ’¬
+ - name: πŸ’¬ Questions or general help
url: https://github.com/microsoft/autogen/discussions
about: Please ask and answer questions here.
+ - name: πŸ’‘ Suggest a new feature
+ url: https://github.com/microsoft/autogen/discussions/categories/feature-suggestions
+ about: Please suggest new features here and once the feature is accepted a maintainer will create an issue.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
deleted file mode 100644
index c984e518e..000000000
--- a/.github/ISSUE_TEMPLATE/feature_request.yml
+++ /dev/null
@@ -1,54 +0,0 @@
-name: Feature Request
-description: Request a new feature or enhancement
-type: "feature"
-
-body:
- - type: markdown
- attributes:
- value: |
- ## Please Read the following before submitting an issue.
-
- ### Have you read the doc?
- - [Python AgentChat User Guide and Tutorial](https://microsoft.github.io/autogen/stable/user-guide/agentchat-user-guide/index.html)
- - [Python Core API User Guide](https://microsoft.github.io/autogen/stable/user-guide/core-user-guide/index.html)
- - [Python API Doc](https://microsoft.github.io/autogen/stable/reference/index.html)
- - [.NET Doc](https://microsoft.github.io/autogen/dotnet/)
-
- ### Have you searched for related issues?
- - Some other users might have the same issue as yours.
-
- ### Are you familiar with GitHub Markdown Syntax?
- Please use [GitHub Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)
- syntax to format your input.
- Pay attention to code blocks. Use "```" blocks for code and output.
- For examples:
-
- ````
- ```python
- # your Python code here.
- ```
- ````
-
- ````
- ```bash
- # your bash shell command here.
- ```
- ````
-
- If your output contains "```", use "````" (four "`") to escape them.
-
- You can use the "Preview" switcher to check your formatted output.
-
- - type: textarea
- attributes:
- 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
- attributes:
- 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/workflows/issue-needs-triage.yml b/.github/workflows/issue-needs-triage.yml
deleted file mode 100644
index 59cb3479c..000000000
--- a/.github/workflows/issue-needs-triage.yml
+++ /dev/null
@@ -1,18 +0,0 @@
-name: Label issues with needs-triage
-on:
- issues:
- types:
- - reopened
- - opened
-jobs:
- label_issues:
- runs-on: ubuntu-latest
- permissions:
- issues: write
- steps:
- - run: gh issue edit "$NUMBER" --add-label "$LABELS"
- env:
- GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- GH_REPO: ${{ github.repository }}
- NUMBER: ${{ github.event.issue.number }}
- LABELS: needs-triage