From 93ef5e99951aaaea03f53a8a816646f3a73c38d6 Mon Sep 17 00:00:00 2001 From: Leonid Pliushch Date: Sat, 14 Aug 2021 15:51:31 +0300 Subject: [PATCH] replace issue templates with forms Enforce properly structured bug reports and package requests. --- .github/ISSUE_TEMPLATE/01-bug-report.yml | 38 ++++++++++++++++++ .github/ISSUE_TEMPLATE/02-package-request.yml | 40 +++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 37 ----------------- .github/ISSUE_TEMPLATE/package_request.md | 23 ----------- 4 files changed, 78 insertions(+), 60 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/01-bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/02-package-request.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/package_request.md diff --git a/.github/ISSUE_TEMPLATE/01-bug-report.yml b/.github/ISSUE_TEMPLATE/01-bug-report.yml new file mode 100644 index 000000000..ba428153e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01-bug-report.yml @@ -0,0 +1,38 @@ +name: "Bug report" +description: "Create a report to help us improve" +title: "[Bug]: " +labels: ["bug report"] +body: + - type: markdown + attributes: + value: | + This is a bug tracker of the official Termux packges. Please do not report issues of third-party software there, but ask in [GitHub Discussions](https://github.com/termux/termux-packages/discussions) or [Community Social Media](https://wiki.termux.com/wiki/Community) instead. Use search to check whether your issue has been already reported. + + Android versions 5.x and 6.x are not supported anymore. Issues happening on these operating system versions will not be resolved. + + Before submitting any repository service issues, check https://github.com/termux/termux-packages/issues/6726. + + To submit a bug report, fill the form below. Provide as much as possible information about the encountered issue. We may request extended information such as `strace` logs if consider necessary. This will help package maintainers to understand the problem correctly and provide a solution. Make sure that your logs do not leak sensitive information (passwords, API keys, etc). Be patient, do not expect that issue could get resolved immediately. + - type: textarea + attributes: + label: Problem description + description: | + A clear and concise description of what the problem is. You may attach the logs, screenshots, screen video recording and whatever else that will help to understand the issue. + + Issues without proper description will be closed without solution. + validations: + required: true + - type: textarea + attributes: + label: What steps will reproduce the bug? + validations: + required: true + - type: textarea + attributes: + label: What is the expected behavior? + - type: textarea + attributes: + label: System information + description: Provide there output of `termux-info`. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/02-package-request.yml b/.github/ISSUE_TEMPLATE/02-package-request.yml new file mode 100644 index 000000000..48b63cf1c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02-package-request.yml @@ -0,0 +1,40 @@ +name: "Package request" +description: "Request a new package" +title: "[Package]: " +labels: ["package request"] +body: + - type: markdown + attributes: + value: | + If our repositories do not provide a package that fullfill your needs, consider requesting it. Use search to check whether package has been requested previously. + + To submit a request of a new package, fill the form below. Be patient, do not expect that package will get added immediately. + - type: textarea + attributes: + label: Package description + description: A clear and concise description of what this package do and why it should be added to Termux repositories. + validations: + required: true + - type: input + attributes: + label: Home page URL + - type: input + attributes: + label: Source code URL + placeholder: Link to Git or source archive + validations: + required: true + - type: checkboxes + attributes: + label: Packaging policy acknowledgement + description: Not every package could be added and do not forget that Termux is operated by limited team and hosting resources. + options: + - label: I have read and understand the [Packaging Policy](https://github.com/termux/termux-packages/blob/master/CONTRIBUTING.md#packaging-policy). + required: true + - type: textarea + attributes: + label: Additional information + description: | + Have you tried to compile it on device? + + If it did not work then provide the error you ran into. Otherwise please share build steps and any patches that you had to apply. diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 9d49b583e..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve - ---- - - - -**Problem description** - - -**Steps to reproduce** - - -**Expected behavior** - - -**Additional information** - -``` - -``` diff --git a/.github/ISSUE_TEMPLATE/package_request.md b/.github/ISSUE_TEMPLATE/package_request.md deleted file mode 100644 index ca81327d8..000000000 --- a/.github/ISSUE_TEMPLATE/package_request.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -name: Package request -about: Suggest a new package. ---- - -## Requesting new package - -- [ ] I have read [Termux packaging policy](https://github.com/termux/termux-packages/blob/master/CONTRIBUTING.md#packaging-policy). - -*** - -### Package description - - -**Link to home page and sources** - -1. Home page: -2. Source code: - -**Additional information** -Have you compiled or tried to compile the package on device? -* If it did not work then please provide the error you ran into. -* If it did work then please share build steps and any patches that you had to apply.