Add issue templates and add some extra notes in USAGE.md
This commit is contained in:
89
.github/ISSUE_TEMPLATE/01-bug-report.yml
vendored
Normal file
89
.github/ISSUE_TEMPLATE/01-bug-report.yml
vendored
Normal file
@@ -0,0 +1,89 @@
|
|||||||
|
name: "⁉️ Bug Report"
|
||||||
|
description: Report a reproducible problem or crash
|
||||||
|
title: "[BUG] "
|
||||||
|
labels: ["bug"]
|
||||||
|
body:
|
||||||
|
- type: input
|
||||||
|
id: bug-description
|
||||||
|
attributes:
|
||||||
|
label: "📝 Bug Description"
|
||||||
|
description: "Clearly describe the bug you encountered."
|
||||||
|
placeholder: "Example: PMT crashes when running `pmt info` on system partition."
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: reproduction-steps
|
||||||
|
attributes:
|
||||||
|
label: "🔄 Steps to Reproduce"
|
||||||
|
description: "List the exact steps to reproduce the issue."
|
||||||
|
placeholder: |
|
||||||
|
1. Command or action you performed
|
||||||
|
2. Next step
|
||||||
|
3. Result
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
id: proof-type
|
||||||
|
attributes:
|
||||||
|
label: "📷 Screenshots or 📜 Logs"
|
||||||
|
description: "At least one is required."
|
||||||
|
multiple: true
|
||||||
|
options:
|
||||||
|
- "Screenshots"
|
||||||
|
- "Logs"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: proof-content
|
||||||
|
attributes:
|
||||||
|
label: "Attach Screenshots or Logs"
|
||||||
|
description: "Paste logs or drag-and-drop image files here."
|
||||||
|
placeholder: "Paste logs or drop images here..."
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
id: pmt-version
|
||||||
|
attributes:
|
||||||
|
label: "💻 PMT Version"
|
||||||
|
placeholder: "Example: v2.3.1"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
id: android-version
|
||||||
|
attributes:
|
||||||
|
label: "📱 Android Version"
|
||||||
|
placeholder: "Example: Android 13"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
id: device-model
|
||||||
|
attributes:
|
||||||
|
label: "📟 Device Model"
|
||||||
|
placeholder: "Example: Pixel 6 Pro"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
id: root-access
|
||||||
|
attributes:
|
||||||
|
label: "🔑 Root Access"
|
||||||
|
options:
|
||||||
|
- "Yes"
|
||||||
|
- "No"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: additional-context
|
||||||
|
attributes:
|
||||||
|
label: "⚠️ Additional Context"
|
||||||
|
description: "Any extra details that could help reproduce the bug."
|
||||||
|
placeholder: "Other relevant info..."
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
48
.github/ISSUE_TEMPLATE/02-feature-request.yml
vendored
Normal file
48
.github/ISSUE_TEMPLATE/02-feature-request.yml
vendored
Normal file
@@ -0,0 +1,48 @@
|
|||||||
|
name: "💡 Feature Request"
|
||||||
|
description: Suggest a new idea or enhancement for PMT
|
||||||
|
title: "[FEATURE] "
|
||||||
|
labels: ["enhancement"]
|
||||||
|
body:
|
||||||
|
- type: input
|
||||||
|
id: feature-title
|
||||||
|
attributes:
|
||||||
|
label: "📝 Feature Title"
|
||||||
|
placeholder: "Example: Add support for ext4 resize"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: feature-description
|
||||||
|
attributes:
|
||||||
|
label: "📌 Feature Description"
|
||||||
|
description: "Clearly describe the feature you want."
|
||||||
|
placeholder: "What should PMT be able to do?"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: why-needed
|
||||||
|
attributes:
|
||||||
|
label: "💡 Why This Feature?"
|
||||||
|
description: "Explain the value or problem it solves."
|
||||||
|
placeholder: "This would be useful because..."
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: possible-implementation
|
||||||
|
attributes:
|
||||||
|
label: "🛠️ Possible Implementation"
|
||||||
|
description: "(Optional) Suggest how it might be implemented."
|
||||||
|
placeholder: "Technical ideas, CLI options, examples..."
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: extra-notes
|
||||||
|
attributes:
|
||||||
|
label: "🗒️ Extra Notes"
|
||||||
|
description: "(Optional) Any other details, diagrams, or references."
|
||||||
|
placeholder: "Additional info..."
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
1
USAGE.md
1
USAGE.md
@@ -202,6 +202,7 @@ pmt reboot [rebootTarget] [OPTIONS]
|
|||||||
- **Asynchronous execution**: For `backup`, `flash`, and `erase`, each partition is processed in a separate thread for maximum speed.
|
- **Asynchronous execution**: For `backup`, `flash`, and `erase`, each partition is processed in a separate thread for maximum speed.
|
||||||
- **Error isolation**: A failure in processing one partition will not cancel the others. Only for `backup`, `flash` and `erase` functions.
|
- **Error isolation**: A failure in processing one partition will not cancel the others. Only for `backup`, `flash` and `erase` functions.
|
||||||
- **Automatic diagnostics**: By default, whether a partition is dynamic or regular is determined automatically. With global options, you only specify precision.
|
- **Automatic diagnostics**: By default, whether a partition is dynamic or regular is determined automatically. With global options, you only specify precision.
|
||||||
|
- **Root access**: Root access is required if operations are to be performed on partitions.
|
||||||
|
|
||||||
## Extra Note: Comma Usage
|
## Extra Note: Comma Usage
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user