Skip to content

Commit ab8a1f7

Browse files
Bring the issue forms and PR template up to date with 2.5
Bug report: current placeholders, a scan method dropdown, a field for the crash log, install options the app can actually tell apart, required checks. The field ids are unchanged, so the "Report on GitHub" prefill still works; CrashLog now sends one of the form's install options, which it never did before, so that field arrived empty. Feature request: the areas list matches the app as it is (Insights, Changes, start screen, palettes, shortcuts, languages). PR template: What / Why / How tested / Screenshots and a checklist taken from CONTRIBUTING (all translation files, where settings and shortcuts go, dotnet test). config.yml: the website line no longer promises a live preview.
1 parent cb7ec59 commit ab8a1f7

4 files changed

Lines changed: 87 additions & 54 deletions

File tree

Lines changed: 39 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,29 @@
11
name: Bug report
2-
description: Something doesn't work the way it should.
2+
description: Something does not work the way it should.
33
title: "[Bug] "
44
labels: ["bug"]
55
body:
66
- type: markdown
77
attributes:
88
value: |
9-
Thanks for taking the time to report this. The more of the fields below you can fill in, the faster it can be fixed.
10-
Tip: the About window (F1) has a **Copy version info** button that fills in the version and system fields for you.
9+
Thanks for reporting this. A few precise details get a bug fixed far faster than a long description, so the form asks for the ones that matter.
10+
11+
**Two shortcuts:** the About window (F1) has **Copy version info**, which fills in the version and system fields below in one paste, and if SpaceSharp showed an "Unexpected error" dialog, its **Report on GitHub** button opens this form already filled in. Crash logs are in About › Crash logs.
1112
1213
- type: textarea
1314
id: what-happened
1415
attributes:
15-
label: What happened?
16-
description: What did you do, and what went wrong?
17-
placeholder: I scanned D:, then double-clicked the Games folder, and the map went blank.
16+
label: What happened
17+
description: What you did, and what went wrong. If an error was shown, paste its text.
18+
placeholder: "I scanned D:, double-clicked the Games folder, and the map went blank."
1819
validations:
1920
required: true
2021

2122
- type: textarea
2223
id: steps
2324
attributes:
2425
label: Steps to reproduce
26+
description: Numbered, from a fresh start of the app if you can.
2527
placeholder: |
2628
1. Scan drive D:
2729
2. Double-click "Games"
@@ -32,25 +34,24 @@ body:
3234
- type: textarea
3335
id: expected
3436
attributes:
35-
label: What did you expect instead?
37+
label: What you expected instead
3638

3739
- type: input
3840
id: version
3941
attributes:
4042
label: SpaceSharp version
41-
description: Shown in the About window (F1).
42-
placeholder: "1.2.0"
43+
description: Shown at the top of the About window (F1).
44+
placeholder: "2.5.0"
4345
validations:
4446
required: true
4547

4648
- type: dropdown
4749
id: install
4850
attributes:
49-
label: How did you install it?
51+
label: How it was installed
5052
options:
51-
- MSI installer
52-
- Setup.exe (one-click)
53-
- Portable SpaceSharp.exe
53+
- Installer (Setup.exe or MSI)
54+
- Portable exe
5455
- Built from source
5556
validations:
5657
required: true
@@ -59,37 +60,50 @@ body:
5960
id: windows
6061
attributes:
6162
label: Windows version
62-
description: From the About window's "Copy version info", or Settings → System → About in Windows.
63+
description: From Copy version info, or Settings › System › About in Windows.
6364
placeholder: "Windows 11 24H2 (26100), x64"
6465

6566
- type: dropdown
6667
id: scan-target
6768
attributes:
68-
label: What were you scanning?
69+
label: What was being scanned
6970
options:
7071
- A whole drive (C:, D:, …)
7172
- A folder
72-
- A network drive or share
7373
- An external or removable drive
74-
- Not scanning / doesn't apply
74+
- A network drive or share
75+
- Not scanning, or does not apply
76+
77+
- type: dropdown
78+
id: scan-method
79+
attributes:
80+
label: Scan method
81+
description: The status bar and the scanning card say which one ran. The file table needs administrator rights and an NTFS drive.
82+
options:
83+
- File table (fast scan, as administrator)
84+
- Folder walk
85+
- A saved scan opened from the start screen
86+
- Not sure
7587

7688
- type: textarea
7789
id: settings
7890
attributes:
7991
label: Relevant settings
80-
description: Map style, size measure, hard-link detection, theme, or anything else that might matter.
81-
placeholder: Style Tiles, size on disk, dark theme
92+
description: "Anything that might matter: Color by, palette, size measure, hard-link detection, exclusions, theme, language."
93+
placeholder: Color by Depth, Graphite palette, size on disk, dark theme, English
8294

8395
- type: textarea
84-
id: screenshots
96+
id: evidence
8597
attributes:
86-
label: Screenshots or error text
87-
description: Paste images here, or the text from the "Unexpected error" dialog if one appeared.
98+
label: Screenshots, error text or crash log
99+
description: Drag images or the crash-*.log file from About › Crash logs into this field.
88100

89101
- type: checkboxes
90102
id: checks
91103
attributes:
92-
label: Checks
104+
label: Before sending
93105
options:
94-
- label: I'm on the latest release (see the Releases page)
95-
- label: I searched existing issues and didn't find this one
106+
- label: I am on the latest release, or the issue says which older version
107+
required: true
108+
- label: I searched the open and closed issues for this
109+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ blank_issues_enabled: true
33
contact_links:
44
- name: Questions and ideas
55
url: https://github.com/SpaceSharpApp/SpaceSharp/issues/new/choose
6-
about: Ask how something works, show a palette you made, or talk through a feature. Pick the Feature request form, or a blank issue for anything else.
6+
about: Ask how something works, share a palette you made, or talk through a feature. Use the Feature request form, or a blank issue for anything else.
77
- name: Website
88
url: https://spacesharp.app/
9-
about: Downloads, a live preview of the app, and the short answers.
9+
about: Downloads, screenshots, and the short answers to the usual questions.
1010
- name: Accessibility
1111
url: https://github.com/SpaceSharpApp/SpaceSharp/blob/main/ACCESSIBILITY.md
1212
about: What works with screen readers, keyboard and high contrast, what does not yet, and how to report it.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,55 +6,63 @@ body:
66
- type: markdown
77
attributes:
88
value: |
9-
Ideas are welcome. Describing the problem you're trying to solve helps more than a specific solution, since there may be a simpler way to get there.
9+
Ideas are welcome. The problem you are trying to solve is worth more than a specific solution: there is often a simpler way to get there, and knowing the goal makes it possible to find it.
1010
1111
- type: textarea
1212
id: problem
1313
attributes:
14-
label: What are you trying to do?
15-
description: The situation or task where SpaceSharp falls short today.
16-
placeholder: I want to find installers I downloaded more than a year ago and never ran, but there's no way to see when a file was last opened.
14+
label: What you are trying to do
15+
description: The situation where SpaceSharp falls short today, in a sentence or two.
16+
placeholder: I want to find installers I downloaded more than a year ago and never ran, but there is no way to see when a file was last opened.
1717
validations:
1818
required: true
1919

2020
- type: textarea
2121
id: proposal
2222
attributes:
23-
label: What would you like SpaceSharp to do?
24-
description: Your idea for how it could work. Rough is fine.
23+
label: What SpaceSharp could do
24+
description: Your idea for how it would work. Rough is fine; a sentence is enough.
2525
validations:
2626
required: true
2727

2828
- type: textarea
2929
id: alternatives
3030
attributes:
31-
label: How do you handle it today?
32-
description: Workarounds, other tools, or "I don't".
31+
label: How you handle it today
32+
description: A workaround, another tool, or "I don't".
3333

3434
- type: dropdown
3535
id: area
3636
attributes:
37-
label: Which part of the app is this about?
37+
label: Part of the app
3838
options:
39-
- Scanning and accuracy
40-
- The map (layout, styles, colors, labels)
39+
- Scanning (speed, accuracy, what is counted)
40+
- The map (layout, shading, colors, labels)
4141
- Zoom and navigation
42-
- Filter and search
42+
- Filter
43+
- Insights and Safe to clear
44+
- Changes (comparing scans)
45+
- Start screen and saved scans
4346
- Side panel (drives, largest items)
47+
- Inspect
4448
- Deleting and cleanup
45-
- Settings and appearance
46-
- Installer and updates
49+
- Palettes, themes and looks
50+
- Settings
51+
- Shortcuts and keyboard
52+
- Languages and translations
53+
- Installer, updates and the command line
4754
- Something else
4855

4956
- type: textarea
5057
id: mockup
5158
attributes:
5259
label: Sketches or examples
53-
description: A drawing, a screenshot from another tool, or a mockup, if you have one.
60+
description: A drawing, a screenshot from another tool, or a mockup, if you have one. Drag images into this field.
5461

5562
- type: checkboxes
5663
id: checks
5764
attributes:
58-
label: Checks
65+
label: Before sending
5966
options:
60-
- label: I searched existing issues and discussions for this idea
67+
- label: I searched the open and closed issues for this idea
68+
required: true

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,27 @@
1-
## What does this change?
1+
<!-- Thanks for the pull request. CONTRIBUTING.md has the conventions; this template is the short version. -->
22

3-
<!-- One or two sentences from the user's point of view. Link the issue if there is one. -->
3+
## What this changes
44

5-
## How was it tested?
5+
<!-- One or two sentences from the user's point of view. Link the issue if there is one: "Fixes #123". -->
66

7-
<!-- Which drives or folders, which styles or settings, light and dark theme? -->
7+
## Why
8+
9+
<!-- The problem it solves or the behavior it corrects. Skip this if the issue says it already. -->
10+
11+
## How it was tested
12+
13+
<!-- Which drives or folders (a real drive with a few hundred thousand files, not only a small folder), both scan methods if scanning is touched, dark and light theme, which settings. -->
14+
15+
## Screenshots
16+
17+
<!-- Before and after, for anything visible. Delete this section otherwise. -->
818

919
## Checklist
1020

11-
- [ ] Builds without warnings
12-
- [ ] Tested on a real drive with a large number of files
13-
- [ ] New settings and shortcuts are in the Settings window, About window and README where applicable
14-
- [ ] `CHANGELOG.md` has an entry under "Unreleased" (add the heading if the last release already shipped)
15-
- [ ] Tests added or updated in `SpaceSharp.Tests` when logic in Layout, Models, Services or Util changed
16-
- [ ] American English in code, comments and UI text
21+
- [ ] One change per pull request, branched from `main`
22+
- [ ] Builds without warnings and `dotnet test` passes
23+
- [ ] Every new user-visible string is in `Strings.resx` and in all seventeen translation files (machine translations are fine); the tests check for missing keys
24+
- [ ] New settings are in `AppSettings`, `SettingsWindow` and `MainWindow.ApplySettings()`; new shortcuts are in `ShortcutsWindow.cs` and the README's shortcut table
25+
- [ ] Tests added or updated in `SpaceSharp.Tests` when logic in `Layout`, `Models`, `Services`, `Scanning` or `Util` changed
26+
- [ ] `CHANGELOG.md` has a line under an "Unreleased" heading, written for the user (add the heading if the last release already shipped)
27+
- [ ] American English in code, comments and UI text; the file keeps the existing style and `.editorconfig` formatting

0 commit comments

Comments
 (0)