From 1fcac16d8500a4b8183a13bf6f879dc39b3e673e Mon Sep 17 00:00:00 2001 From: Sai-Suraj-27 Date: Thu, 27 Jul 2023 10:32:17 +0530 Subject: [PATCH] Added Issue_Templates to distinguish between bug_reports, feature_requests, and doubts. --- .github/ISSUE_TEMPLATES/bug_report.yaml | 56 ++++++++++++++++++++ .github/ISSUE_TEMPLATES/config.yaml | 7 +++ .github/ISSUE_TEMPLATES/feature_request.yaml | 20 +++++++ 3 files changed, 83 insertions(+) create mode 100644 .github/ISSUE_TEMPLATES/bug_report.yaml create mode 100644 .github/ISSUE_TEMPLATES/config.yaml create mode 100644 .github/ISSUE_TEMPLATES/feature_request.yaml diff --git a/.github/ISSUE_TEMPLATES/bug_report.yaml b/.github/ISSUE_TEMPLATES/bug_report.yaml new file mode 100644 index 00000000..03b963b3 --- /dev/null +++ b/.github/ISSUE_TEMPLATES/bug_report.yaml @@ -0,0 +1,56 @@ +name: Bug report +description: Create a report to help us improve +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: textarea + id: what-happened + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is, and any additional context. + placeholder: Tell us what you see! + validations: + required: true + - type: textarea + id: repro-steps + attributes: + label: To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. Fetch a '...' + 2. Update the '....' + 3. See error + validations: + required: true + - type: textarea + id: code-snippets + attributes: + label: Code snippets + description: If applicable, add code snippets to help explain your problem. + render: Python + validations: + required: false + - type: input + id: os + attributes: + label: OS + placeholder: macOS + validations: + required: true + - type: input + id: language-version + attributes: + label: Python version + placeholder: Python v3.7.1 + validations: + required: false + - type: input + id: gprMax-version + attributes: + label: gprMax version + placeholder: gprMax v.3.1.6 + validations: + required: false diff --git a/.github/ISSUE_TEMPLATES/config.yaml b/.github/ISSUE_TEMPLATES/config.yaml new file mode 100644 index 00000000..9e6cfade --- /dev/null +++ b/.github/ISSUE_TEMPLATES/config.yaml @@ -0,0 +1,7 @@ +blank_issues_enabled: false +contact_links: + - name: gprMax support + url: https://groups.google.com/g/gprmax + about: | + Please only file issues here that you believe represent actual bugs or feature requests for the gprMax software. + If you're having general trouble with using gprMax, please visit our help center to get support. diff --git a/.github/ISSUE_TEMPLATES/feature_request.yaml b/.github/ISSUE_TEMPLATES/feature_request.yaml new file mode 100644 index 00000000..905acd15 --- /dev/null +++ b/.github/ISSUE_TEMPLATES/feature_request.yaml @@ -0,0 +1,20 @@ +name: Feature request +description: Suggest an idea for gprMax software +labels: ["feature-request"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this feature request! Please note, we may not able to accommodate all feature requests given limited bandwidth but we appreciate you taking the time to share with us how to improve the gprMax software. + - type: textarea + id: feature + attributes: + label: Describe the feature or improvement you're requesting + description: A clear and concise description of what you want to happen. + validations: + required: true + - type: textarea + id: context + attributes: + label: Additional context + description: Add any other context about the feature request here.