From a7c9240616bcd12259f53fae8b7894aa01b8564c Mon Sep 17 00:00:00 2001 From: Berkan Sasmaz Date: Mon, 7 Nov 2022 10:41:24 +0300 Subject: [PATCH] add new issue templates --- .github/ISSUE_TEMPLATE/01_bug_report.yml | 148 ++++++++++++++++++ .github/ISSUE_TEMPLATE/02_feature_request.yml | 34 ++++ .github/ISSUE_TEMPLATE/03_article_request.yml | 20 +++ .../ISSUE_TEMPLATE/04_performance_issue.md | 49 ++++++ .../05_blank_issue.md} | 9 ++ .github/ISSUE_TEMPLATE/config.yml | 8 + .../ISSUE_TEMPLATES/community-post-request.md | 3 - .github/ISSUE_TEMPLATES/feature.md | 1 - 8 files changed, 268 insertions(+), 4 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/01_bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/02_feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/03_article_request.yml create mode 100644 .github/ISSUE_TEMPLATE/04_performance_issue.md rename .github/{ISSUE_TEMPLATE => ISSUE_TEMPLATE/05_blank_issue.md} (87%) create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATES/community-post-request.md delete mode 100644 .github/ISSUE_TEMPLATES/feature.md diff --git a/.github/ISSUE_TEMPLATE/01_bug_report.yml b/.github/ISSUE_TEMPLATE/01_bug_report.yml new file mode 100644 index 0000000000..a2b33b7637 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01_bug_report.yml @@ -0,0 +1,148 @@ +name: 🐞 Bug Report +description: Create a report to help us improve +labels: [bug] +body: + - type: markdown + attributes: + value: | + We welcome bug reports! This template will help us gather the information we need to start the triage process. + + Please keep in mind that the GitHub issue tracker is not intended as a general support forum, but for reporting **non-security** bugs and feature requests. + If you believe you have an issue that affects the SECURITY of the platform, please do NOT create an issue and instead email your issue details to info@abp.io. + For other types of questions, consider using [StackOverflow](https://stackoverflow.com/questions/tagged/abp). + - type: checkboxes + id: searched + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered ([abp/issues](https://github.com/abpframework/abp/issues)). + options: + - label: I have searched the existing issues + required: true + - type: textarea + id: background + attributes: + label: Description + description: Please share a clear and concise description of the problem. + placeholder: Description + validations: + required: true + - type: textarea + id: repro-steps + attributes: + label: Reproduction Steps + description: | + Please include minimal steps to reproduce the problem if possible. E.g.: the smallest possible code snippet; or a small project, with steps to run it. If possible include text as text rather than screenshots (so it shows up in searches). + placeholder: Minimal Reproduction + validations: + required: false + - type: textarea + id: expected-behavior + attributes: + label: Expected behavior + description: | + Provide a description of the expected behavior. + placeholder: Expected behavior + validations: + required: false + - type: textarea + id: actual-behavior + attributes: + label: Actual behavior + description: | + Provide a description of the actual behavior observed. If applicable please include any error messages, exception stacktraces or memory dumps. + placeholder: Actual behavior + validations: + required: false + - type: textarea + id: regression + attributes: + label: Regression? + description: | + Did this work in a previous build or release of ABP framework? If you can try a previous release or build to find out, that can help us narrow down the problem. If you don't know, that's OK. + placeholder: Regression? + validations: + required: false + - type: textarea + id: known-workarounds + attributes: + label: Known Workarounds + description: | + Please provide a description of any known workarounds. + placeholder: Known Workarounds + validations: + required: false + - type: markdown + attributes: + value: | + ## Configuration + Please provide more information on your ABP configuration. + - type: input + id: version + attributes: + label: Version + description: Which version of ABP is the code running on? + placeholder: Version + validations: + required: true + - type: dropdown + id: user-interface + attributes: + label: User Interface + description: Which user interface of ABP is related to the problem? + options: + - Common (Default) + - MVC + - Angular + - Blazor + - Blazor Server + - React Native + - MAUI + validations: + required: true + - type: dropdown + id: database-provider + attributes: + label: Database Provider + description: Which database provider of ABP is used? + options: + - EF Core (Default) + - MongoDB + - None/Others + validations: + required: true + - type: dropdown + id: structure + attributes: + label: Tiered or separate authentication server + description: Which structure of ABP is specified? + options: + - None (Default) + - Tiered + - Separate Auth Server + validations: + required: true + - type: dropdown + id: Operation-System + attributes: + label: Operation System + description: What is the operation system of the server? + options: + - Windows (Default) + - Linux + - macOS + - Others + validations: + required: true + - type: markdown + attributes: + value: | + --- + - type: textarea + id: other-info + attributes: + label: Other information + description: | + If you have an idea where the problem might lie, let us know that here. Please include any pointers to code, relevant changes, or related issues you know of. + placeholder: Other information + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/02_feature_request.yml b/.github/ISSUE_TEMPLATE/02_feature_request.yml new file mode 100644 index 0000000000..21189e3a30 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02_feature_request.yml @@ -0,0 +1,34 @@ +name: 💡 Feature request +description: Suggest an idea for this project +labels: [feature] +body: +- type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the feature you are requesting. (https://github.com/abpframework/abp/issues). + options: + - label: I have searched the existing issues + required: true +- type: textarea + attributes: + label: Is your feature request related to a problem? Please describe the problem. + description: A clear and concise description of what the problem is. + placeholder: I am trying to do [...] but [...] + validations: + required: false +- type: textarea + attributes: + label: Describe the solution you'd like + description: | + A clear and concise description of what you want to happen. Include any alternative solutions you've considered. + placeholder: I would like to see [...] + validations: + required: true +- type: textarea + attributes: + label: Additional context + description: | + Add any other context or screenshots about the feature request here. + placeholder: Add any other context or screenshots about the feature request here. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/03_article_request.yml b/.github/ISSUE_TEMPLATE/03_article_request.yml new file mode 100644 index 0000000000..34082596c5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/03_article_request.yml @@ -0,0 +1,20 @@ +name: 💎 Article request +description: Article suggestion you want to be published on community.abp.io +labels: [community-article-request] +body: + - type: checkboxes + id: searched + attributes: + label: Is there an existing article or article request for this? + description: Please search to see if there is an article or article request related to your article request ([community.abp.io](https://community.abp.io/posts), [abp/issues](https://github.com/abpframework/abp/issues?q=is%3Aopen+is%3Aissue+label%3Acommunity-article-request)) + options: + - label: I have searched the existing resources + required: true + - type: textarea + attributes: + label: Describe the article you'd like + description: | + Please describe the article you'd like to be published on community.abp.io. + If you have any reference article, please share it here. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/04_performance_issue.md b/.github/ISSUE_TEMPLATE/04_performance_issue.md new file mode 100644 index 0000000000..fb3d724f92 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/04_performance_issue.md @@ -0,0 +1,49 @@ +--- +name: Performance issue +about: Report a performance problem or regression +title: '' +labels: 'problem' +assignees: '' + +--- + + + +### Description + + + +### Configuration + + + +### Regression? + + + +### Data + + + +### Analysis + + diff --git a/.github/ISSUE_TEMPLATE b/.github/ISSUE_TEMPLATE/05_blank_issue.md similarity index 87% rename from .github/ISSUE_TEMPLATE rename to .github/ISSUE_TEMPLATE/05_blank_issue.md index 414985237d..35138a6eed 100644 --- a/.github/ISSUE_TEMPLATE +++ b/.github/ISSUE_TEMPLATE/05_blank_issue.md @@ -1,3 +1,12 @@ +--- +name: Blank issue +about: Something that doesn't fit the other categories +title: '' +labels: '' +assignees: '' + +--- + ### Documentation Please check the official documentation before asking questions: https://docs.abp.io diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..8da2082360 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: true +contact_links: + - name: Issue with ABP Commercial + url: https://support.abp.io/QA/Questions + about: Please open issues relating to ABP Commercial in support.abp.io. + - name: Ask a question (community support) + url: https://stackoverflow.com/questions/tagged/abp + about: Ask a question that will be answered by the ABP community diff --git a/.github/ISSUE_TEMPLATES/community-post-request.md b/.github/ISSUE_TEMPLATES/community-post-request.md deleted file mode 100644 index 1559e50a6c..0000000000 --- a/.github/ISSUE_TEMPLATES/community-post-request.md +++ /dev/null @@ -1,3 +0,0 @@ -Please explain the content (an article or a video tutorial) that you would like to see on the ABP Community website, https://community.abp.io. - -Before creating your own request, please check existing requests: https://github.com/abpframework/abp/labels/community-article-request \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATES/feature.md b/.github/ISSUE_TEMPLATES/feature.md deleted file mode 100644 index 3cc5678c46..0000000000 --- a/.github/ISSUE_TEMPLATES/feature.md +++ /dev/null @@ -1 +0,0 @@ -Please describe the feature need! \ No newline at end of file