From fd6d8f8a16c113daec2fb33d825ed00b9c5b03f4 Mon Sep 17 00:00:00 2001 From: classabbyamp Date: Wed, 30 Mar 2022 00:51:29 -0400 Subject: [PATCH 1/2] .github/ISSUE_TEMPLATE: add bug report and package request issue forms Co-authored-by: 0x5c --- .github/ISSUE_TEMPLATE/bug-report.yml | 70 ++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/pkg-request.yml | 67 ++++++++++++++++++++++++ .github/issue_template.md | 14 ------ 4 files changed, 138 insertions(+), 14 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/pkg-request.yml delete mode 100644 .github/issue_template.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 000000000000..8870ae1cfe71 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,70 @@ +name: Bug Report +description: File a bug report +labels: ["bug"] +body: + - type: markdown + attributes: + value: > + ### Don't request an update of a package, + [We have a script for that](https://alpha.de.repo.voidlinux.org/void-updates/void-updates.txt). + However, a quality pull request may help. + - id: xuname + type: input + attributes: + label: System Info + description: Output of `xuname` (part of [`xtools`](https://man.voidlinux.org/xtools.1)) + placeholder: Void 5.x.y_z x86_64-musl ... + validations: + required: true + - id: packages + type: input + attributes: + label: Package(s) Affected + description: Affected package(s) including version + placeholder: foo-1.0.2_5, bar-5.6.7_1, baz-0.0.3_5, ... + validations: + required: true + - id: upstream + type: textarea + attributes: + label: Does a report exist for this bug with the project's home (upstream) and/or another distro? + description: If so, link it here (It's fine if there's none) + placeholder: | + For example: + https://bugs.kde.org/show_bug.cgi?id=432975 + https://bugs.gentoo.org/767478 + - id: expected + type: textarea + attributes: + label: Expected behaviour + description: A clear and concise description of what you expected to happen + placeholder: The package is supposed to do this thing. + validations: + required: true + - id: description + type: textarea + attributes: + label: Bug description + description: A clear and concise description of what the bug is + placeholder: There was a crash when... + validations: + required: true + - id: steps + type: textarea + attributes: + label: Steps to reproduce + description: Clear steps to reproduce the bug + placeholder: | + 1. Do the thing + 2. Do the other thing + 3. ??? + 4. Crash :( + validations: + required: true + - id: verified + type: checkboxes + attributes: + label: Is this a new report? + options: + - label: I verified that there isn't already an open issue for this bug + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000000..0086358db1eb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true diff --git a/.github/ISSUE_TEMPLATE/pkg-request.yml b/.github/ISSUE_TEMPLATE/pkg-request.yml new file mode 100644 index 000000000000..04b0eabd95e7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/pkg-request.yml @@ -0,0 +1,67 @@ +name: Package Request +description: Request the addition of a package +labels: ["request"] +body: + - type: markdown + attributes: + value: > + ### Don't request an update of a package, + [We have a script for that](https://alpha.de.repo.voidlinux.org/void-updates/void-updates.txt). + However, a quality pull request may help. + - id: name + type: input + attributes: + label: Package name + placeholder: foobar9k + - id: description + type: textarea + attributes: + label: Description + description: What does the package do? + placeholder: > + Foobar9k is a music player that turns your music up to 11. + It provides features X, Y, and Z, which other music players in Void don't. + - type: markdown + attributes: + value: > + ## Quality Requirements + + To be included in the Void repository, software must meet **at least one** of the following requirements. + Exceptions to the list are possible, and might be accepted, but are extremely unlikely. + If you believe you have an exception, start a PR and make an argument for why that particular piece of software, + while not meeting any of the following requirements, is a good candidate for the Void packages system. + + + In particular, new themes are highly unlikely to be accepted. + Simple shell scripts are unlikely to be accepted unless they provide considerable value to a broad user base. + New fonts may be accepted if they provide value beyond aesthetics + (e.g. they contain glyphs for a script missing in already packaged fonts). + + + Browser forks, including those based on Chromium and Firefox, are generally not accepted. + Such forks require heavy patching, maintenance and hours of build time. + - id: quality + type: checkboxes + attributes: + label: Does the requested package meet the quality requirements? + options: + - label: "System: The software should be installed system-wide, not per-user" + required: false + - label: "Compiled: The software needs to be compiled before being used, even if it is software that is not needed by the whole system" + required: false + - label: "Required: Another package either within the repository or pending inclusion requires the package" + required: false + - type: markdown + attributes: + value: > + ## Release Status + + Software need to be used in version announced by authors as ready to use by the general public - usually called releases. + Betas, pre-releases, and arbitrary VCS revisions won't be accepted. + - id: released + type: checkboxes + attributes: + label: Is the requested package released? + options: + - label: "Released: The software is available in a version announced by authors as ready-to-use by the general public" + required: true diff --git a/.github/issue_template.md b/.github/issue_template.md deleted file mode 100644 index 25a0538174cc..000000000000 --- a/.github/issue_template.md +++ /dev/null @@ -1,14 +0,0 @@ - -### System - -* xuname: - *output of ``xuname`` (part of xtools)* -* package: - *affected package(s) including the version*: ``xbps-query -p pkgver `` - -### Expected behavior - -### Actual behavior - -### Steps to reproduce the behavior - From 6b63116bacba45f724a933d3b542161812235314 Mon Sep 17 00:00:00 2001 From: classabbyamp Date: Fri, 1 Apr 2022 13:49:33 -0400 Subject: [PATCH 2/2] update templates [TEMP] --- .github/ISSUE_TEMPLATE/bug-report.yml | 11 ++++--- .github/ISSUE_TEMPLATE/pkg-request.yml | 40 +++++++++++++++++++------- 2 files changed, 36 insertions(+), 15 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 8870ae1cfe71..d3bd546ab414 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -5,7 +5,7 @@ body: - type: markdown attributes: value: > - ### Don't request an update of a package, + #### Don't request an update of a package, [We have a script for that](https://alpha.de.repo.voidlinux.org/void-updates/void-updates.txt). However, a quality pull request may help. - id: xuname @@ -44,7 +44,7 @@ body: - id: description type: textarea attributes: - label: Bug description + label: Actual behaviour description: A clear and concise description of what the bug is placeholder: There was a crash when... validations: @@ -65,6 +65,9 @@ body: type: checkboxes attributes: label: Is this a new report? + description: I verified that there isn't already an open issue for this bug options: - - label: I verified that there isn't already an open issue for this bug - required: true + - Yes + - No + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/pkg-request.yml b/.github/ISSUE_TEMPLATE/pkg-request.yml index 04b0eabd95e7..07d37e9ebaad 100644 --- a/.github/ISSUE_TEMPLATE/pkg-request.yml +++ b/.github/ISSUE_TEMPLATE/pkg-request.yml @@ -5,7 +5,7 @@ body: - type: markdown attributes: value: > - ### Don't request an update of a package, + #### Don't request an update of a package, [We have a script for that](https://alpha.de.repo.voidlinux.org/void-updates/void-updates.txt). However, a quality pull request may help. - id: name @@ -13,6 +13,15 @@ body: attributes: label: Package name placeholder: foobar9k + validations: + required: true + - id: homepage + type: input + attributes: + label: Package homepage + placeholder: https://foobar9k.org + validations: + required: true - id: description type: textarea attributes: @@ -21,6 +30,8 @@ body: placeholder: > Foobar9k is a music player that turns your music up to 11. It provides features X, Y, and Z, which other music players in Void don't. + validations: + required: true - type: markdown attributes: value: > @@ -28,8 +39,8 @@ body: To be included in the Void repository, software must meet **at least one** of the following requirements. Exceptions to the list are possible, and might be accepted, but are extremely unlikely. - If you believe you have an exception, start a PR and make an argument for why that particular piece of software, - while not meeting any of the following requirements, is a good candidate for the Void packages system. + If you believe you have an exception, make an argument for why that particular piece of software, + while not meeting any of the following requirements, is a good candidate for inclusion in void-packages. In particular, new themes are highly unlikely to be accepted. @@ -44,13 +55,17 @@ body: type: checkboxes attributes: label: Does the requested package meet the quality requirements? + description: | + **System:** The software should be installed system-wide, not per-user + **Compiled:** The software needs to be compiled before being used, even if it is software that is not needed by the whole system + **Required:** Another package either within the repository or pending inclusion requires the package + multiple: true options: - - label: "System: The software should be installed system-wide, not per-user" - required: false - - label: "Compiled: The software needs to be compiled before being used, even if it is software that is not needed by the whole system" - required: false - - label: "Required: Another package either within the repository or pending inclusion requires the package" - required: false + - System + - Compiled + - Required + validations: + required: true - type: markdown attributes: value: > @@ -59,9 +74,12 @@ body: Software need to be used in version announced by authors as ready to use by the general public - usually called releases. Betas, pre-releases, and arbitrary VCS revisions won't be accepted. - id: released - type: checkboxes + type: dropdown attributes: label: Is the requested package released? + description: "The software is available in a version announced by authors as ready-to-use by the general public" options: - - label: "Released: The software is available in a version announced by authors as ready-to-use by the general public" + - Yes + - No + validations: required: true