Skip to content

Commit

Permalink
Use forms for Issue and PR templates
Browse files Browse the repository at this point in the history
  • Loading branch information
droidmonkey committed Dec 8, 2024
1 parent f71cca4 commit d8115ce
Show file tree
Hide file tree
Showing 7 changed files with 195 additions and 101 deletions.
39 changes: 0 additions & 39 deletions .github/ISSUE_TEMPLATE/bug-report.md

This file was deleted.

78 changes: 78 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
name: Bug Report
description: Provide information about a problem you are experiencing.
type: Bug

body:
- type: checkboxes
attributes:
label: Have you searched for an existing issue?
description: Use the issue search box to see if one already exists for the bug you encountered.
options:
- label: Yes, I tried searching
required: true

- type: textarea
id: summary
attributes:
label: Brief Summary
description: |
Provide an overview of the problem, include any information that may help us triage this issue.
Provide screenshots if possible, but do NOT show sensitive data (use View -> Allow Screen Capture).
required: true

- type: textarea
id: steps
attributes:
label: Steps to Reproduce
description: Provide a simple set of steps to reproduce this bug.
placeholder: |
1.
2.
3.
required: true

- type: textarea
id: expected_vs_actual
attributes:
label: Expected Versus Actual Behavior
description: Tell us what you expected to happen and what actually happened.

- type: textarea
id: debug_info
attributes:
label: KeePassXC Debug Information
placeholder: "Paste the output of: Help -> About -> Debug Info"
render: Text

- type: dropdown
id: os
attributes:
label: Operating System
description: Select your operating system.
options:
- Windows
- Linux
- macOS

- type: dropdown
id: desktop_env
attributes:
label: Linux Desktop Environment
description: If on Linux, please select your desktop environment.
options:
- Gnome
- KDE
- XFCE
- Mate / Cinnamon
- Sway
- i3
- Other

- type: dropdown
id: window_system
attributes:
label: Linux Windowing System
description: If on Linux, please select your windowing system.
options:
- X11
- Wayland
19 changes: 0 additions & 19 deletions .github/ISSUE_TEMPLATE/feature-request.md

This file was deleted.

33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Feature Request
description: Tell us about a new feature you want.
type: Feature

body:
- type: checkboxes
attributes:
label: Have you searched for an existing feature request?
description: Use the issue search box to see if one already exists for the feature you want.
options:
- label: Yes, I tried searching
required: true

- type: textarea
id: summary
attributes:
label: Brief Summary
description: |
Provide an overview of the feature you are interested in adding.
Provide screenshots if possible, but do NOT show sensitive data (use View -> Allow Screen Capture).
required: true

- type: textarea
id: example
attributes:
label: Example
description: Provide an example of how this feature would be used.

- type: textarea
id: context
attributes:
label: Context
description: Why does this feature matter to you? What unique circumstances do you have?
80 changes: 80 additions & 0 deletions .github/ISSUE_TEMPLATE/prerelease_bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
name: Pre-Release Bug Report
description: Report an issue with pre-release code (e.g. snapshot builds).
type: Bug
labels: PRE-RELEASE BUG
assignees: droidmonkey

body:
- type: checkboxes
attributes:
label: Have you searched for an existing issue?
description: Use the issue search box to see if one already exists for the bug you encountered.
options:
- label: Yes, I tried searching
required: true

- type: textarea
id: summary
attributes:
label: Brief Summary
description: |
Provide an overview of the problem, include any information that may help us triage this issue.
Provide screenshots if possible, but do NOT show sensitive data (use View -> Allow Screen Capture).
required: true

- type: textarea
id: steps
attributes:
label: Steps to Reproduce
description: Provide a simple set of steps to reproduce this bug.
placeholder: |
1.
2.
3.
required: true

- type: textarea
id: expected_vs_actual
attributes:
label: Expected Versus Actual Behavior
description: Tell us what you expected to happen and what actually happened.

- type: textarea
id: debug_info
attributes:
label: KeePassXC Debug Information
placeholder: "Paste the output of: Help -> About -> Debug Info"
render: Text

- type: dropdown
id: os
attributes:
label: Operating System
description: Select your operating system.
options:
- Windows
- Linux
- macOS

- type: dropdown
id: desktop_env
attributes:
label: Linux Desktop Environment
description: If on Linux, please select your desktop environment.
options:
- Gnome
- KDE
- XFCE
- Mate / Cinnamon
- Sway
- i3
- Other

- type: dropdown
id: window_system
attributes:
label: Linux Windowing System
description: If on Linux, please select your windowing system.
options:
- X11
- Wayland
39 changes: 0 additions & 39 deletions .github/ISSUE_TEMPLATE/release-preview-bug-report.md

This file was deleted.

8 changes: 4 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
[NOTE]: # ( Describe your changes in detail, why is this change required? )
[NOTE]: # ( Explain large or complex code modifications. )
[NOTE]: # ( If it fixes an open issue, please add "Fixes #XXX" )
[NOTE]: # ( If it fixes an open issue, please add "Fixes #XXX". )


## Screenshots
[TIP]: # ( Do not include screenshots of your actual database! )

[NOTE]: # ( Do not include screenshots of your actual database! )
[TIP]: # ( Use View -> Allow Screen Capture )

## Testing strategy
[NOTE]: # ( Please describe in detail how you tested your changes. )
[TIP]: # ( We expect new code to be covered by unit tests and documented with doc blocks! )
[TIP]: # ( We expect new code to be covered by unit tests and include helpful comments. )


## Type of change
Expand Down

0 comments on commit d8115ce

Please sign in to comment.