From c7f30633731e655e5c94398186744f2ca6ba8664 Mon Sep 17 00:00:00 2001 From: sauwming Date: Thu, 27 Apr 2023 18:55:30 +0800 Subject: [PATCH] Update Github issue template (#3533) --- .github/ISSUE_TEMPLATE/bug_report.yml | 14 ++++++----- .github/ISSUE_TEMPLATE/feature_request.md | 20 ---------------- .github/ISSUE_TEMPLATE/feature_request.yml | 28 ++++++++++++++++++++++ 3 files changed, 36 insertions(+), 26 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md 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 index 1babec15c..8eb01545a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,24 +1,26 @@ -name: Bug Report +name: Bug report description: File a bug report body: - type: markdown attributes: value: | - Thanks for taking the time to fill out this bug report! + Thank you for filing a bug report with us. We appreciate your effort in helping us improve our software. + + **IMPORTANT**: Please note that this form is **strictly** for reporting bugs, and as such, any questions or inquiries that are not related to bugs will be closed. We apologize for any inconvenience this may cause and appreciate your understanding in keeping our bug reporting system focused and efficient. - type: textarea id: bug-desc attributes: label: Describe the bug description: A clear and concise description of what the bug is. placeholder: | - E.g: Assertion in answering an incoming video call with response code 183. + E.g: Assertion when answering an incoming video call with response code 183. validations: required: true - type: textarea id: bug-repro attributes: label: Steps to reproduce - description: Describe how to reproduce the bug using sample apps such as [pjsua app](https://www.pjsip.org/pjsua.htm), [pjsua2 android](https://trac.pjsip.org/repos/wiki/Getting-Started/Android#Tryingoursampleapplicationandcreatingyourown), [iOS ipjsua](https://trac.pjsip.org/repos/wiki/Getting-Started/iPhone#BuildingPJSIP), or [other sample apps](https://github.com/pjsip/pjproject/tree/master/pjsip-apps/src/samples). + description: Describe how to reproduce the bug using sample apps such as [pjsua app](https://www.pjsip.org/pjsua.htm), [pjsua2 android](https://docs.pjsip.org/en/latest/get-started/android/build_instructions.html#building-and-running-pjsua2-sample-application), [iOS ipjsua](https://docs.pjsip.org/en/latest/get-started/ios/build_instructions.html#building-pjsip), or [other sample apps](https://github.com/pjsip/pjproject/tree/master/pjsip-apps/src/samples). placeholder: | E.g: 1. run pjsua app with parameter: `--video --registrar sip:some.sip.registrar ...` @@ -31,9 +33,9 @@ body: id: version attributes: label: PJSIP version - description: What PJSIP version are you using? + description: What PJSIP version are you using? (We suggest testing with the latest version to ensure that the bug is still present and has not been resolved.) placeholder: | - E.g: 2.11 + E.g: 2.13 validations: required: true - type: textarea diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 3166f9133..000000000 --- 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: 'type: enhancement' -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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..a10f536de --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,28 @@ +name: Feature request +description: Submit a feature request +labels: 'type: enhancement' +body: + - type: markdown + attributes: + value: | + Thank you for submitting a feature request to us. + + **IMPORTANT**: Please note that this form is **strictly** for feature request submission, and as such, any questions or inquiries that are not related to feature requests will be closed. We apologize for any inconvenience this may cause and appreciate your understanding in keeping our Github issues focused and efficient. + - type: textarea + id: feature-req + attributes: + label: Describe the feature + description: A clear and concise description of what feature you wish for. + validations: + required: true + - type: textarea + id: alt-solution + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've +considered. + - type: textarea + id: context + attributes: + label: Additional context + description: Add any other context or screenshots about the feature request here.