From 6c3e3521935f91e5c56d4dfbc4fe8098b9b564f4 Mon Sep 17 00:00:00 2001 From: Michael Prokop Date: Wed, 6 Dec 2023 12:37:32 +0100 Subject: [PATCH] MT#58934 Provide GitHub issue templates The rtpengine GitHub issue tracker is not a support forum, so let's point user to the mailing list instead, and provide initial bug report + feature request templates, while at it. Change-Id: I7414b94131def5f19cdc5cc17d41684007b12bf2 --- .github/ISSUE_TEMPLATE/bug_report.yml | 97 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 ++ .github/ISSUE_TEMPLATE/feature_request.yml | 44 ++++++++++ 3 files changed, 149 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000000..dbda700075 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,97 @@ +--- +# vi: ts=2 sw=2 et: + +name: Bug Report +description: Report a problem +labels: ["bug"] + +body: + - type: markdown + attributes: + value: Thanks for taking the time to fill out this bug report! + + - type: input + id: version + attributes: + label: rtpengine version the issue has been seen with + description: | + Please use `rtpengine --version` to get the rtpengine version. + placeholder: '12.2.0.0+0~mr12.2.0.0+0~20231205160601.20604+bookworm~1.gbpa75a82' + validations: + required: false + + - type: input + id: distro + attributes: + label: Used distribution and its version + description: | + Please use `lsb_release -a` to get the distribution information. + placeholder: Debian 12 + validations: + required: false + + - type: input + id: kernel + attributes: + label: Linux kernel version used + description: | + Please use `uname -r` to get linux kernel version. + placeholder: 6.1.0-13-amd64 + validations: + required: false + + + - type: dropdown + id: architecture + attributes: + label: CPU architecture issue was seen on (see `uname -m`) + options: + - amd64 + - arm64 + - armhf + - i386 + - other + validations: + required: false + + - type: textarea + id: expected-behaviour + attributes: + label: Expected behaviour you didn't see + validations: + required: false + + - type: textarea + id: unexpected-behaviour + attributes: + label: Unexpected behaviour you saw + validations: + required: false + + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to reproduce the problem + validations: + required: false + + - type: textarea + id: logs + attributes: + label: Additional program output to the terminal or logs illustrating the issue + description: | + Please paste relevant program terminal or log output here. + Where copy/paste is not possible, a photo of the screen might do too, but text is always much preferred. + placeholder: This will be automatically formatted into code, so no need for backticks. + render: shell + validations: + required: false + + - type: textarea + id: additional-information + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the issue you are encountering! + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..c1a7d3e19e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +--- +# vi: ts=2 sw=2 et: + +blank_issues_enabled: true +contact_links: + - name: rtpengine mailing list + url: https://rtpengine.com/mailing-list + about: Please ask questions on the mailing list. The issue tracker here is NOT a support forum. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000000..7036fd4da1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,44 @@ +--- +# vi: ts=2 sw=2 et: + +name: Feature request +description: Suggest an improvement +labels: ["feature"] + +body: + - type: markdown + attributes: + value: Thanks for taking the time to fill out this feature request! + + - type: textarea + id: description + attributes: + label: Is your feature request related to a problem? Please describe + description: A clear and concise description of what the problem is. + validations: + required: false + + - type: textarea + id: solution + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + validations: + required: false + + - type: textarea + id: alternatives + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: false + + - type: input + id: version + attributes: + label: The rtpengine version you checked that didn't have the feature you are asking for + description: If this is not the most recently released upstream version, then please check first if it has that feature already. + placeholder: '12.2.0.0+0~mr12.2.0.0+0~20231205160601.20604+bookworm~1.gbpa75a82' + validations: + required: false