Skip to content

Commit

Permalink
Update issue templates (#5686)
Browse files Browse the repository at this point in the history
  • Loading branch information
jackgerrits authored Feb 25, 2025
1 parent 6bc896f commit a54a85e
Show file tree
Hide file tree
Showing 6 changed files with 76 additions and 76 deletions.
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
name: Bug Report
name: 🐛 Bug Report
description: Report a bug
type: "bug"
labels:
- needs-triage

body:
- type: markdown
attributes:
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)
Expand Down
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/2-doc_issue.yml
Original file line number Diff line number Diff line change
@@ -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
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/3-maintainer_only.yml
Original file line number Diff line number Diff line change
@@ -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

7 changes: 5 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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.
54 changes: 0 additions & 54 deletions .github/ISSUE_TEMPLATE/feature_request.yml

This file was deleted.

18 changes: 0 additions & 18 deletions .github/workflows/issue-needs-triage.yml

This file was deleted.

0 comments on commit a54a85e

Please sign in to comment.