33 lines
1.2 KiB
Markdown
33 lines
1.2 KiB
Markdown
---
|
|
description: mtm-ddwipe project conventions
|
|
---
|
|
|
|
# Project conventions
|
|
- Use English.
|
|
- Use Bash for shell scripts.
|
|
- Keep `mtm-ddwipe` focused on wiping block devices.
|
|
- Keep `mtm-ddwipe` interactive by default.
|
|
- Require explicit confirmation before destructive actions.
|
|
- Validate real block devices and refuse mounted or in-use targets.
|
|
- Show clear device details before confirmation.
|
|
- Keep destructive safeguards strict and explicit.
|
|
- Keep messages short and clear.
|
|
- Keep help concise, usage-first, and warning-focused.
|
|
- Preserve the fallback wipe flow: secure discard, zero discard, then `dd` zero-fill.
|
|
- Keep optional tools optional.
|
|
- Use extra wipe methods only if the command is present.
|
|
- Use `ddrescue` or `dd_rescue` only after `dd` fails.
|
|
- Keep `nvme` and `hdparm` optional.
|
|
- Use `nvme` and `hdparm` only on matching device types.
|
|
- Do not make new external tools required.
|
|
- Keep changes minimal and preserve intent.
|
|
- Keep this file aligned and concise.
|
|
- Prefer tabs for indentation.
|
|
- Prefer `${var}` notation in Bash.
|
|
- If non-interactive support is added, make it an opt-in safety flag.
|
|
|
|
# Project identity
|
|
- Main script: `mtm-ddwipe`
|
|
- License: GNU GPL v3
|
|
|