Github messages for voidlinux
 help / color / mirror / Atom feed
* [PR PATCH] .github/ISSUE_TEMPLATE: add bug report and package request issue forms
@ 2022-03-30  5:34 classabbyamp
  2022-03-30  8:37 ` [PR REVIEW] " paper42
                   ` (51 more replies)
  0 siblings, 52 replies; 53+ messages in thread
From: classabbyamp @ 2022-03-30  5:34 UTC (permalink / raw)
  To: ml

[-- Attachment #1: Type: text/plain, Size: 2079 bytes --]

There is a new pull request by classabbyamp against master on the void-packages repository

https://github.com/classabbyamp/void-packages new-issue-templates
https://github.com/void-linux/void-packages/pull/36411

.github/ISSUE_TEMPLATE: add bug report and package request issue forms
Co-authored-by: @0x5c 

This PR replaces the existing markdown-based issue template with two new [Github issue forms](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms), one for bug reports and one for package requests.

These ensure that the relevant information is asked for and the required information is provided. They also automagically tag issues with the `bug` and `request` tags. If preferred, new bug reports could be also be marked with a second `unconfirmed` or `needs triage` label, applied by the form.

Issues that do not fall under these types can still be opened by clicking the "open a blank issue" button on the template chooser:
![image](https://user-images.githubusercontent.com/5366828/160756504-21812fa5-c0a0-4c9d-a454-7094fa034ef2.png)
This can be limited to maintainers by changing `blank_issues_enabled` to `false` in `.github/ISSUE_TEMPLATE/config.yml` if desired.

`config.yml` can also be used to add additional arbitrary links in the template chooser. Here's an example [config.yml](https://github.com/miaowware/qrm2/blob/master/.github/ISSUE_TEMPLATE/config.yml) and resulting [template chooser](https://github.com/miaowware/qrm2/issues/new/choose) in another project.

#### Testing the changes
- I tested the changes in this PR: **YES**
    A preview of the rendered templates can be seen [here for the bug report](https://github.com/classabbyamp/void-packages/blob/new-issue-templates/.github/ISSUE_TEMPLATE/bug-report.yml) and [here for the package request](https://github.com/classabbyamp/void-packages/blob/new-issue-templates/.github/ISSUE_TEMPLATE/pkg-request.yml)

[ci skip]

A patch file from https://github.com/void-linux/void-packages/pull/36411.patch is attached

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-new-issue-templates-36411.patch --]
[-- Type: text/x-diff, Size: 7290 bytes --]

From fd6d8f8a16c113daec2fb33d825ed00b9c5b03f4 Mon Sep 17 00:00:00 2001
From: classabbyamp <dev@kb6.ee>
Date: Wed, 30 Mar 2022 00:51:29 -0400
Subject: [PATCH] .github/ISSUE_TEMPLATE: add bug report and package request
 issue forms

Co-authored-by: 0x5c <dev@0x5c.io>
---
 .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 @@
-<!-- Don't request update of 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. -->
-### System
-
-* xuname:  
-  *output of ``xuname`` (part of xtools)*
-* package:  
-  *affected package(s) including the version*: ``xbps-query -p pkgver <pkgname>``
-
-### Expected behavior
-
-### Actual behavior
-
-### Steps to reproduce the behavior
-

^ permalink raw reply	[flat|nested] 53+ messages in thread
end of thread, other threads:[~2022-06-17  3:44 UTC | newest]

Thread overview: 53+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-03-30  5:34 [PR PATCH] .github/ISSUE_TEMPLATE: add bug report and package request issue forms classabbyamp
2022-03-30  8:37 ` [PR REVIEW] " paper42
2022-03-30  8:37 ` paper42
2022-03-30  8:40 ` paper42
2022-03-30 16:56 ` classabbyamp
2022-03-30 18:14 ` Chocimier
2022-03-30 23:39 ` [PR REVIEW] " 0x5c
2022-03-31  0:38 ` 0x5c
2022-03-31  1:29 ` 0x5c
2022-04-01 17:49 ` [PR PATCH] [Updated] " classabbyamp
2022-04-01 17:52 ` classabbyamp
2022-04-01 17:53 ` classabbyamp
2022-04-01 17:54 ` classabbyamp
2022-04-01 17:55 ` classabbyamp
2022-04-01 17:58 ` classabbyamp
2022-04-02 21:39 ` [PR PATCH] [Updated] " classabbyamp
2022-04-14 18:44 ` classabbyamp
2022-04-14 18:44 ` classabbyamp
2022-04-14 20:25 ` classabbyamp
2022-04-14 20:38 ` [PR REVIEW] " paper42
2022-04-14 20:38 ` paper42
2022-04-14 20:40 ` classabbyamp
2022-04-14 20:43 ` [PR PATCH] [Updated] " classabbyamp
2022-04-14 20:46 ` [PR REVIEW] " classabbyamp
2022-04-14 20:50 ` 0x5c
2022-04-14 20:57 ` Chocimier
2022-04-14 20:58 ` [PR REVIEW] " 0x5c
2022-04-14 21:13 ` 0x5c
2022-04-14 21:22 ` [PR REVIEW] " paper42
2022-04-14 21:23 ` paper42
2022-04-14 21:23 ` classabbyamp
2022-04-14 21:23 ` classabbyamp
2022-04-14 21:25 ` paper42
2022-04-14 21:29 ` classabbyamp
2022-04-14 21:48 ` [PR PATCH] [Updated] " classabbyamp
2022-04-19 15:33 ` classabbyamp
2022-04-19 17:48 ` Chocimier
2022-04-19 17:59 ` [PR PATCH] [Updated] " classabbyamp
2022-04-19 18:00 ` classabbyamp
2022-04-19 18:00 ` classabbyamp
2022-05-01  6:36 ` [PR REVIEW] " 0x5c
2022-06-10 20:48 ` [PR PATCH] [Updated] " classabbyamp
2022-06-10 20:51 ` classabbyamp
2022-06-10 20:52 ` [PR REVIEW] " classabbyamp
2022-06-10 20:56 ` [PR PATCH] [Updated] " classabbyamp
2022-06-10 20:59 ` classabbyamp
2022-06-14 18:33 ` Chocimier
2022-06-14 19:26 ` [PR PATCH] [Updated] " classabbyamp
2022-06-14 19:27 ` classabbyamp
2022-06-14 19:27 ` classabbyamp
2022-06-14 19:33 ` Chocimier
2022-06-14 19:39 ` [PR PATCH] [Updated] " classabbyamp
2022-06-17  3:44 ` [PR PATCH] [Merged]: " classabbyamp

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).