From 18ffa5c2ab64cb0a6addfa29e0ac86eee824bfad Mon Sep 17 00:00:00 2001 From: Pratap Mahey Date: Mon, 23 May 2022 21:17:23 +0530 Subject: [PATCH 1/5] chore: update issue templates --- .github/ISSUE_TEMPLATE/bug-report.yml | 58 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 30 ----------- .github/ISSUE_TEMPLATE/feature-request.yml | 49 ++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 -------- 4 files changed, 107 insertions(+), 50 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000000..1f5d2d9e65 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,58 @@ +name: 🐛 Bug Report +description: Report a reproducible bug. +title: "Bug report: " +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 + - 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. iOS], Python version [e.g. 3.8.5], AEA version [e.g. 1.0.0], ... + validations: + required: true + - type: textarea + id: logs + attributes: + label: Failure Logs + description: Include any relevant log snippets or files here + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 721ab7cded..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Do '....' -3. See error '...' - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - AEA Version [e.g. 1.0.0] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000000..8ae8dd27b0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,49 @@ +name: ☝️ Feature request +description: Suggest an idea for this project +title: "Feature request: " +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 + - 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 diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index bbcbbe7d61..0000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. From 642bc4c600151459e2243dd9f09a683410119575 Mon Sep 17 00:00:00 2001 From: S Ali Hosseini <38721653+5A11@users.noreply.github.com> Date: Tue, 24 May 2022 08:42:09 +0100 Subject: [PATCH 2/5] Minor update to bug-report template --- .github/ISSUE_TEMPLATE/bug-report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 1f5d2d9e65..fac6a4622c 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -46,7 +46,7 @@ body: 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. iOS], Python version [e.g. 3.8.5], AEA version [e.g. 1.0.0], ... + Operating system [e.g. MacOS], Python version [e.g. 3.8.5], AEA version [e.g. 1.2.0], ... validations: required: true - type: textarea From 5cce6e4ebb05f0892d03af5ee376e9926b0df44f Mon Sep 17 00:00:00 2001 From: Pratap Mahey Date: Tue, 24 May 2022 16:40:36 +0530 Subject: [PATCH 3/5] chore: added COC to issue templates --- .github/ISSUE_TEMPLATE/bug-report.yml | 2 ++ .github/ISSUE_TEMPLATE/feature-request.yml | 2 ++ 2 files changed, 4 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index fac6a4622c..6705cfb9de 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -19,6 +19,8 @@ body: 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](../../CODE_OF_CONDUCT.md) before creating this issue. + required: true - type: textarea id: expected attributes: diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index 8ae8dd27b0..bc5d862ab2 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -17,6 +17,8 @@ body: 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](../../CODE_OF_CONDUCT.md) before creating this issue. + required: true - type: textarea id: problem attributes: From 18c0c49a893141a51c7eeb2dde5b8f80d6e45437 Mon Sep 17 00:00:00 2001 From: UrAvgDeveloper Date: Wed, 25 May 2022 10:14:57 +0530 Subject: [PATCH 4/5] Update bug-report.yml --- .github/ISSUE_TEMPLATE/bug-report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 6705cfb9de..6829271ef7 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -19,7 +19,7 @@ body: 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](../../CODE_OF_CONDUCT.md) before creating this issue. + - 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 From dc8ba7f094301eca2fc4b68ac1b8c2dd9a34cd40 Mon Sep 17 00:00:00 2001 From: UrAvgDeveloper Date: Wed, 25 May 2022 10:15:31 +0530 Subject: [PATCH 5/5] Update feature-request.yml --- .github/ISSUE_TEMPLATE/feature-request.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index bc5d862ab2..6644e84923 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -17,7 +17,7 @@ body: 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](../../CODE_OF_CONDUCT.md) before creating this issue. + - 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