Skip to content

Commit

Permalink
.github/ISSUE_TEMPLATE: add bug report and package request issue forms
Browse files Browse the repository at this point in the history
Co-authored-by: 0x5c <dev@0x5c.io>
  • Loading branch information
classabbyamp and 0x5c committed Apr 2, 2022
1 parent 71848ff commit c6c4ae7
Show file tree
Hide file tree
Showing 4 changed files with 159 additions and 14 deletions.
73 changes: 73 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
@@ -0,0 +1,73 @@
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: Actual behaviour
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: dropdown
attributes:
label: Is this a new report?
description: I verified that there isn't already an open issue for this bug
options:
- "Yes"
- "No"
validations:
required: true
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1 @@
blank_issues_enabled: true
85 changes: 85 additions & 0 deletions .github/ISSUE_TEMPLATE/pkg-request.yml
@@ -0,0 +1,85 @@
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
validations:
required: true
- id: homepage
type: input
attributes:
label: Package homepage
placeholder: https://foobar9k.org
validations:
required: true
- 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.
validations:
required: true
- 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, 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.
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: dropdown
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:
- System
- Compiled
- Required
validations:
required: true
- 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: 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:
- "Yes"
- "No"
validations:
required: true
14 changes: 0 additions & 14 deletions .github/issue_template.md

This file was deleted.

0 comments on commit c6c4ae7

Please sign in to comment.