Improve README framing and add issue/label maintainer tooling
This commit is contained in:
92
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
Executable file
92
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
Executable file
@@ -0,0 +1,92 @@
|
||||
name: Bug report
|
||||
description: Report incorrect behavior, regressions, or build/install failures
|
||||
title: "[bug] "
|
||||
labels:
|
||||
- bug
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for reporting an issue. Please provide enough detail to reproduce the problem.
|
||||
- type: dropdown
|
||||
id: issue_area
|
||||
attributes:
|
||||
label: Area
|
||||
description: Which area best fits this issue?
|
||||
options:
|
||||
- distro-compat
|
||||
- integration
|
||||
- icons
|
||||
- architecture/runtime
|
||||
- ci
|
||||
- docs
|
||||
- other
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: deskify_version
|
||||
attributes:
|
||||
label: Deskify version
|
||||
description: For example `v0.1.0-alpha.2` or commit SHA
|
||||
placeholder: v0.1.0-alpha.2
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: distro
|
||||
attributes:
|
||||
label: Linux distribution
|
||||
description: Include distro + version
|
||||
placeholder: Fedora 41 / Arch Linux / Ubuntu 24.04
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: desktop_environment
|
||||
attributes:
|
||||
label: Desktop environment / session
|
||||
description: Include DE/WM and Wayland/X11 if relevant
|
||||
placeholder: GNOME (Wayland), KDE Plasma (X11), Hyprland
|
||||
- type: textarea
|
||||
id: command
|
||||
attributes:
|
||||
label: Command used
|
||||
description: Exact command that triggered the issue
|
||||
placeholder: |
|
||||
deskify build --url "https://example.com" --name "Example"
|
||||
render: bash
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: expected
|
||||
attributes:
|
||||
label: Expected behavior
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: actual
|
||||
attributes:
|
||||
label: Actual behavior / error output
|
||||
description: Paste the relevant error message or describe what happened
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: repro_steps
|
||||
attributes:
|
||||
label: Steps to reproduce
|
||||
placeholder: |
|
||||
1. Install prerequisites...
|
||||
2. Run `deskify ...`
|
||||
3. Observe ...
|
||||
validations:
|
||||
required: true
|
||||
- type: checkboxes
|
||||
id: checks
|
||||
attributes:
|
||||
label: Before submitting
|
||||
options:
|
||||
- label: I checked the README/known limitations and prerequisites
|
||||
required: true
|
||||
- label: I included distro/environment details
|
||||
required: true
|
||||
- label: I included the exact command and error output
|
||||
required: true
|
||||
|
||||
11
.github/ISSUE_TEMPLATE/config.yml
vendored
Executable file
11
.github/ISSUE_TEMPLATE/config.yml
vendored
Executable file
@@ -0,0 +1,11 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Deskify README
|
||||
url: https://github.com/spalencsar/deskify/blob/master/README.md
|
||||
about: Check installation requirements, known limitations, usage examples, and release notes first.
|
||||
- name: Contributing Guide
|
||||
url: https://github.com/spalencsar/deskify/blob/master/CONTRIBUTING.md
|
||||
about: Read local checks, smoke-test guidance, and contribution expectations before opening work-related issues/PRs.
|
||||
- name: Maintainer Notes (Labels / Triage)
|
||||
url: https://github.com/spalencsar/deskify/blob/master/docs/maintainer-notes.md
|
||||
about: Reference label categories and alpha-phase triage conventions.
|
||||
72
.github/ISSUE_TEMPLATE/feature-request.yml
vendored
Executable file
72
.github/ISSUE_TEMPLATE/feature-request.yml
vendored
Executable file
@@ -0,0 +1,72 @@
|
||||
name: Feature request
|
||||
description: Suggest a user-facing improvement, integration idea, or architectural direction
|
||||
title: "[feature] "
|
||||
labels:
|
||||
- enhancement
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for the suggestion. Feature requests are most helpful when they describe the problem first, then the proposed solution.
|
||||
- type: dropdown
|
||||
id: request_area
|
||||
attributes:
|
||||
label: Area
|
||||
description: Which area best fits this request?
|
||||
options:
|
||||
- integration
|
||||
- icons
|
||||
- architecture/runtime
|
||||
- distro-compat
|
||||
- docs
|
||||
- ci
|
||||
- other
|
||||
validations:
|
||||
required: true
|
||||
- type: checkboxes
|
||||
id: design_signal
|
||||
attributes:
|
||||
label: Design impact
|
||||
description: Tick this if the request changes long-term project direction
|
||||
options:
|
||||
- label: This likely affects architecture or long-term product direction (`design decision`)
|
||||
required: false
|
||||
- type: textarea
|
||||
id: problem
|
||||
attributes:
|
||||
label: Problem statement
|
||||
description: What problem are you trying to solve?
|
||||
placeholder: |
|
||||
I want to ...
|
||||
The current limitation is ...
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: proposed_solution
|
||||
attributes:
|
||||
label: Proposed solution
|
||||
description: Describe the behavior/API/CLI change you would like to see
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: alternatives
|
||||
attributes:
|
||||
label: Alternatives considered
|
||||
description: What are you doing today, or what other options did you consider?
|
||||
placeholder: PWAs, Flatpak web apps, manual `.desktop` entries, etc.
|
||||
- type: textarea
|
||||
id: scope
|
||||
attributes:
|
||||
label: Scope / rollout thoughts (optional)
|
||||
description: If relevant, suggest MVP scope or phased rollout
|
||||
placeholder: Could start as..., later evolve into...
|
||||
- type: checkboxes
|
||||
id: checks
|
||||
attributes:
|
||||
label: Before submitting
|
||||
options:
|
||||
- label: I described the problem, not only the implementation idea
|
||||
required: true
|
||||
- label: I checked existing issues/discussions for duplicates
|
||||
required: true
|
||||
|
||||
Reference in New Issue
Block a user