Skip to content

Commit

Permalink
Update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
5A11 authored May 25, 2022
2 parents 436b9ca + dc8ba7f commit 0ef5816
Show file tree
Hide file tree
Showing 4 changed files with 111 additions and 50 deletions.
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: 🐛 Bug Report
description: Report a reproducible bug.
title: "Bug report: <short description>"
labels: ["bug", "unconfirmed"]
body:
- type: markdown
attributes:
value: |
Thank you for reporting the issue you are facing. Please complete the following so we can have the details necessary to assist you.
- type: checkboxes
id: prerequisites
attributes:
label: Prerequisites
description: Please confirm before submitting a new issue
options:
- label: I am running the [latest version of the AEA Framework](https://docs.fetch.ai/aea/version/).
required: true
- label: I checked the [documentation](https://docs.fetch.ai/aea/) and found no answer to my problem.
required: true
- label: I checked the [existing issues](https://github.com/fetchai/agents-aea/issues) to make sure my problem has not already been reported.
required: true
- label: I have read the [code of conduct](https://github.com/fetchai/agents-aea/blob/main/CODE_OF_CONDUCT.md) before creating this issue.
required: true
- type: textarea
id: expected
attributes:
label: Expected Behavior
description: Describe the behavior you are expecting
validations:
required: true
- type: textarea
id: actual
attributes:
label: Current Behavior
description: Describe the current behavior
validations:
required: true
- type: textarea
id: steps
attributes:
label: To Reproduce
description: Detailed steps for reproducing the issue
validations:
required: false
- type: textarea
id: context
attributes:
label: Context
description: Any relevant information about your setup (this is important in case the issue is not reproducible except for under certain conditions)
placeholder: |
Operating system [e.g. MacOS], Python version [e.g. 3.8.5], AEA version [e.g. 1.2.0], ...
validations:
required: true
- type: textarea
id: logs
attributes:
label: Failure Logs
description: Include any relevant log snippets or files here
validations:
required: false
30 changes: 0 additions & 30 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: ☝️ Feature request
description: Suggest an idea for this project
title: "Feature request: <short description>"
labels: ["enhancement", "unconfirmed"]
body:
- type: markdown
attributes:
value: |
Thank you for suggesting a new idea for this project. Please complete the following to ensure we have all the details to get things started.
- type: checkboxes
id: prerequisites
attributes:
label: Prerequisites
description: Please confirm before submitting a feature request.
options:
- label: I checked the [documentation](https://docs.fetch.ai/aea/) and made sure this feature does not already exist.
required: true
- label: I checked the [existing issues](https://github.com/fetchai/agents-aea/issues) to make sure this feature has not already been requested.
required: true
- label: I have read the [code of conduct](https://github.com/fetchai/agents-aea/blob/main/CODE_OF_CONDUCT.md) before creating this issue.
required: true
- type: textarea
id: problem
attributes:
label: Problem
description: |
If your feature request relates to a problem, provide a description here, e.g. I'm always frustrated when [...]
validations:
required: false
- type: textarea
id: solution
attributes:
label: Feature / Solution
description: |
Provide a description of what you want to happen
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives
description: |
Provide any alternative solutions or features you've considered
- type: textarea
id: info
attributes:
label: Additional Context
description: |
Any other context or screenshots about the feature request
validations:
required: false
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

0 comments on commit 0ef5816

Please sign in to comment.