Skip to content

Commit 35fc30e

Browse files
committed
Add GitHub issue templates for bug reports and feature requests
Bug template requires: vmkatz version, input format, guest OS/arch, host platform, filesystem, full command output, and file details. Blank issues disabled to enforce structured reports.
1 parent 3706710 commit 35fc30e

3 files changed

Lines changed: 161 additions & 0 deletions

File tree

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
name: Bug Report
2+
description: Something isn't working as expected
3+
labels: ["bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for reporting! Please fill in the details below so we can reproduce and fix the issue.
9+
10+
- type: dropdown
11+
id: mode
12+
attributes:
13+
label: Extraction mode
14+
description: What were you trying to extract?
15+
options:
16+
- LSASS credentials (memory snapshot)
17+
- SAM/LSA/DCC2 (virtual disk)
18+
- NTDS.dit (domain controller disk)
19+
- VMFS raw device (ESXi)
20+
- LSASS minidump (.dmp)
21+
- Other
22+
validations:
23+
required: true
24+
25+
- type: input
26+
id: version
27+
attributes:
28+
label: VMkatz version
29+
description: Output of `vmkatz --version` or the release tag you downloaded
30+
placeholder: "v1.2.2"
31+
validations:
32+
required: true
33+
34+
- type: dropdown
35+
id: input-format
36+
attributes:
37+
label: Input file format
38+
options:
39+
- VMware snapshot (.vmsn + .vmem)
40+
- VMware suspend (.vmss + .vmem)
41+
- VirtualBox saved state (.sav)
42+
- QEMU ELF core dump (.elf)
43+
- Hyper-V saved state (.vmrs)
44+
- Hyper-V legacy (.bin)
45+
- VMDK (sparse or flat)
46+
- VDI
47+
- QCOW2
48+
- VHDX / VHD
49+
- Raw disk / block device
50+
- VMFS raw SCSI device
51+
- Raw registry hives (SAM/SYSTEM/SECURITY)
52+
- LSASS minidump (.dmp)
53+
- Other
54+
validations:
55+
required: true
56+
57+
- type: dropdown
58+
id: guest-os
59+
attributes:
60+
label: Guest Windows version
61+
description: The Windows version inside the VM
62+
options:
63+
- Windows XP / Server 2003
64+
- Windows Vista / Server 2008
65+
- Windows 7 / Server 2008 R2
66+
- Windows 8 / Server 2012
67+
- Windows 8.1 / Server 2012 R2
68+
- Windows 10 (specify build in description)
69+
- Windows 11 (specify build in description)
70+
- Windows Server 2016
71+
- Windows Server 2019
72+
- Windows Server 2022
73+
- Windows Server 2025
74+
- Unknown
75+
validations:
76+
required: true
77+
78+
- type: dropdown
79+
id: guest-arch
80+
attributes:
81+
label: Guest architecture
82+
options:
83+
- x64 (64-bit)
84+
- x86 (32-bit)
85+
- Unknown
86+
validations:
87+
required: true
88+
89+
- type: input
90+
id: host-platform
91+
attributes:
92+
label: Host platform
93+
description: Where are you running vmkatz? Include OS and version.
94+
placeholder: "ESXi 6.5, Ubuntu 22.04, Windows 11, macOS 14, etc."
95+
validations:
96+
required: true
97+
98+
- type: input
99+
id: filesystem
100+
attributes:
101+
label: Filesystem (if relevant)
102+
description: For ESXi — VMFS-5 or VMFS-6? (`esxcli storage filesystem list`)
103+
placeholder: "VMFS-6, ext4, NTFS, etc."
104+
105+
- type: textarea
106+
id: command
107+
attributes:
108+
label: Command and full output
109+
description: The exact command you ran and the complete output (including errors).
110+
render: shell
111+
placeholder: |
112+
$ ./vmkatz snapshot.vmsn
113+
[*] vmkatz v1.2.2
114+
Error: ...
115+
validations:
116+
required: true
117+
118+
- type: textarea
119+
id: file-info
120+
attributes:
121+
label: Input file details
122+
description: |
123+
Run `ls -lh` on the files you're passing to vmkatz.
124+
For .vmsn: is there a matching .vmem in the same directory?
125+
render: shell
126+
placeholder: |
127+
$ ls -lh *.vmsn *.vmem
128+
-rw-r--r-- 1 root root 4.0G abc-Snapshot5.vmsn
129+
-rw-r--r-- 1 root root 8.0G abc-Snapshot5.vmem
130+
131+
- type: textarea
132+
id: extra
133+
attributes:
134+
label: Additional context
135+
description: Anything else that might help (VBS/Credential Guard enabled, special VM config, etc.)

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Feature Request
2+
description: Suggest a new feature or improvement
3+
labels: ["enhancement"]
4+
body:
5+
- type: textarea
6+
id: description
7+
attributes:
8+
label: Description
9+
description: What would you like vmkatz to do?
10+
validations:
11+
required: true
12+
13+
- type: textarea
14+
id: use-case
15+
attributes:
16+
label: Use case
17+
description: Describe the scenario where this feature would be useful.
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
id: alternatives
23+
attributes:
24+
label: Alternatives considered
25+
description: Any workarounds or other tools you're currently using for this?

0 commit comments

Comments
 (0)