Add new issue templates.

2025-12-16 19:24:25 +00:00 · 2020-11-12 00:49:31 +00:00
parent 6877589cc9
commit 0184bbdb31
6 changed files with 155 additions and 25 deletions
--- a/.github/ISSUE_TEMPLATE/bug_report_general.md
+++ b/.github/ISSUE_TEMPLATE/bug_report_general.md
@@ -1,3 +1,9 @@
+---
+name: General Bug Report Template
+about: "Bugs report on other commands."
+
+---
+
 ### Prerequisites

 * [ ] Are you running the latest version?
@@ -6,44 +12,27 @@
 ### Check and fill as appropriate:
 * [ ] I was running Aaru under Windows [version here]...
 * [ ] I was running Aaru under Linux [version here]...
-* [ ] I was running Aaru under FreeBSD [version here]...
 * [ ] I was running Aaru under macOS [version here]...
-* [ ] ...using .NET Framework [version here]...
-* [ ] ...using .NET Core [version here]...
-* [ ] ...using Mono [version here]...
 * [ ] ...in 32-bit
 * [ ] ...in 64-bit
+* [ ] ...using an Intel / AMD processor
+* [ ] ...using an ARM or Apple Silicon processor

 ### Description

-[Description of the bug or feature]
+<!-- Description of the bug -->

 ### Exact command line used:

 `Aaru [command] [parameters]`

 ### Expected behavior:
-[What you expected to happen]
+<!-- What did you expect to happen -->

 ### Actual behavior:
-[What actually happened]
+<!-- What actually happened -->

-### If command was expected to work with a device fill this out:
-
-* **Manufacturer**:
-* **Model**:
-* **Bus**:
-    * [ ] Parallel ATA
-    * [ ] Serial ATA
-    * [ ] SCSI (any)
-    * [ ] ATAPI (mark above if parallel or serial)
-    * [ ] USB
-    * [ ] FireWire
-    * [ ] PCMCIA
-    * [ ] SecureDigital
-    * [ ] MultiMediaCard
-    
 ### Output of command execution with debug output enabled
 ```
 Paste the whole output of the executed command when you append '-d' to your command line parameters here
-```
+```
--- a/.github/ISSUE_TEMPLATE/bug_report_image.md
+++ b/.github/ISSUE_TEMPLATE/bug_report_image.md
@@ -0,0 +1,53 @@
+---
+name: Image Bug Report Template
+about: "Bugs report on commands that handle images, like converting or extracting."
+
+---
+
+### Prerequisites
+
+* [ ] Are you running the latest version?
+* [ ] Can you reproduce the problem in the debug version?
+
+### Check and fill as appropriate:
+* [ ] I was running Aaru under Windows [version here]...
+* [ ] I was running Aaru under Linux [version here]...
+* [ ] I was running Aaru under macOS [version here]...
+* [ ] ...in 32-bit
+* [ ] ...in 64-bit
+* [ ] ...using an Intel / AMD processor
+* [ ] ...using an ARM or Apple Silicon processor
+    * **Image format**:  
+    * **Application that created the image**:
+* [ ] I was converting the image...
+    * ...**Destination image format**:
+* [ ] I was listing the filesystem contents...
+* [ ] I was extracting the filesystem contents...
+    * ...**Filesystem**:
+    * [ ] Analyze command recognizes the filesystem
+* [ ] I was creating a metadata sidecar
+* [ ] I was checksumming the image
+* [ ] I was verifying the image
+
+### Description
+
+<!-- Description of the bug -->
+
+### Exact command line used:
+
+`Aaru [command] [parameters]`
+
+### Expected behavior:
+<!-- What did you expect to happen -->
+
+### Actual behavior:
+<!-- What actually happened -->
+
+### Output of command execution with debug output enabled
+```
+Paste the whole output of the executed command when you append '-d' to your command line parameters here
+```
+
+### Image
+<!-- Upload the image, compressed and with the number of this issue. -->
+<!--- If the image contains personal data contact the project lead, and the image contents will be handled confidentially under the GDPR requirements. -->
--- a/.github/ISSUE_TEMPLATE/bug_report_media.md
+++ b/.github/ISSUE_TEMPLATE/bug_report_media.md
@@ -0,0 +1,64 @@
+---
+name: Media Bug Report Template
+about: "Bugs report on commands that handle media, like dumping or retrieving information."
+
+---
+
+### Prerequisites
+
+* [ ] Are you running the latest version?
+* [ ] Can you reproduce the problem in the debug version?
+
+### Check and fill as appropriate:
+* [ ] I was running Aaru under Windows [version here]...
+* [ ] I was running Aaru under Linux [version here]...
+* [ ] I was running Aaru under macOS [version here]...
+* [ ] ...in 32-bit
+* [ ] ...in 64-bit
+* [ ] ...using an Intel / AMD processor
+* [ ] ...using an ARM or Apple Silicon processor
+* **Device manufacturer**:
+* **Model**:
+* **Bus**:
+    * [ ] Parallel ATA
+    * [ ] Serial ATA
+    * [ ] SCSI (any)
+    * [ ] ATAPI (mark above if parallel or serial)
+    * [ ] USB
+      * **USB cable manufacturer**:
+      * **USB cable model**:
+    * [ ] FireWire
+    * [ ] PCMCIA
+    * [ ] SecureDigital
+      * [ ] Using a USB card reader
+          * **USB card reader manufacturer**:
+          * **USB card reader model**:
+    * [ ] MultiMediaCard
+        * [ ] Using a USB card reader
+            * **USB card reader manufacturer**:
+            * **USB card reader model**:
+* [ ] I was dumping media (disk, tape, etc)...
+* [ ] I was analyzing media (disk, tape, etc)...
+* [ ] I was scanning media (disk, tape, etc)...
+
+### Description
+
+<!-- Description of the bug -->
+
+### Exact command line used:
+
+`Aaru [command] [parameters]`
+
+### Expected behavior:
+<!-- What did you expect to happen -->
+
+### Actual behavior:
+<!-- What actually happened -->
+
+### Output of command execution with debug output enabled
+```
+Paste the whole output of the executed command when you append '-d' to your command line parameters here
+```
+
+### Media details
+<!-- Photo, EAN-13, if possible eBay link -->
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,25 @@
+---
+name: Feature Request Template
+about: "For feature requests. Please search for existing issues first. Also see CONTRIBUTING."
+
+---
+
+<!--- Provide a general summary of the issue in the Title above -->
+
+### Check and fill as appropriate:
+* [ ] Support for a new media image format...
+* [ ] Support for identifying a new filesystem...
+* [ ] Support for extracting files from a new filesystem...
+* [ ] New command...
+* [ ] Improvement to output...
+* [ ] Other...
+
+## Detailed Description
+<!--- Provide a detailed description of the change or addition you are proposing -->
+
+## Context
+<!--- Why is this change important to you? How would you use it? -->
+<!--- How can it benefit other users? -->
+
+## Known documentation
+<!--- Attach documentation, links to specifications or existing source code -->
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -3,7 +3,7 @@
 - [ ] Bug fix (non-breaking change which fixes an issue)
 - [ ] New feature (non-breaking change which adds functionality)
 - [ ] New filesystem, test images in [url]
- [ ] New disc image, test images in [url]
+- [ ] New media image, test images in [url]
 - [ ] New partition scheme, test images in [url]
 - [ ] Breaking change (fix or feature that would cause existing functionality to change)
 - [ ] I have read the **CONTRIBUTING** document.