Initial public release of Warp.
Repo-Sync-Origin: warpdotdev/warp-internal@12af1d983b
This commit is contained in:
@@ -0,0 +1,39 @@
|
||||
# Examples
|
||||
|
||||
Use these only to calibrate tone and structure. Do not copy them mechanically.
|
||||
|
||||
## Example 1: Bug
|
||||
|
||||
Rough feedback:
|
||||
|
||||
`Warp loses my selected theme after restart on macOS. I changed it twice and it keeps going back.`
|
||||
|
||||
Draft shape:
|
||||
|
||||
- classification: `bug`
|
||||
- title: `Theme selection resets after restarting Warp on macOS`
|
||||
- missing details: Warp version, macOS version, whether the issue reproduces every restart
|
||||
|
||||
Key body moves:
|
||||
|
||||
- turn the complaint into a concrete restart flow
|
||||
- state the expected persisted theme behavior
|
||||
- mark unknown version details as `Unknown`
|
||||
|
||||
## Example 2: Feature Request
|
||||
|
||||
Rough feedback:
|
||||
|
||||
`The command palette is too hard to scan. I want better grouping for settings-related actions.`
|
||||
|
||||
Draft shape:
|
||||
|
||||
- classification: `feature request`
|
||||
- title: `Improve Command Palette grouping for settings-related actions`
|
||||
- missing details: concrete commands that are hardest to find, screenshots if the user has them
|
||||
|
||||
Key body moves:
|
||||
|
||||
- describe the current friction instead of inventing reproduction steps
|
||||
- focus the request on the desired workflow and user impact
|
||||
- draft immediately unless a specific missing fact blocks clarity
|
||||
@@ -0,0 +1,33 @@
|
||||
# Log And Crash Artifact Guidance
|
||||
|
||||
Use this only for crashes, startup failures, rendering bugs, sync issues, or hard-to-reproduce regressions.
|
||||
|
||||
- Ask for logs only when they are likely to improve the report.
|
||||
- Note in the issue that logs or crash reports were attached, but do not claim they contain console input or output.
|
||||
- In the `Artifacts` section, mention the exact file names or bundles that were attached.
|
||||
|
||||
macOS paths and commands:
|
||||
|
||||
- Logs live under `~/Library/Logs/`
|
||||
- Stable app logs are typically `~/Library/Logs/warp.log*`
|
||||
- Preview app logs are typically `~/Library/Logs/warp_preview.log*`
|
||||
- Stable zip command: `zip -j ~/Desktop/warp-logs.zip ~/Library/Logs/warp.log*`
|
||||
- Preview zip command: `zip -j ~/Desktop/warp_preview-logs.zip ~/Library/Logs/warp_preview.log*`
|
||||
- If Warp still opens, the user can search `View Warp Logs` in the Command Palette
|
||||
- Crash reports may also exist under `~/Library/Logs/DiagnosticReports/` as Warp `.ips` files
|
||||
|
||||
Linux paths:
|
||||
|
||||
- Logs live under Warp's state directory.
|
||||
- Stable app logs are typically `~/.local/state/warp-terminal/warp.log*`
|
||||
- Preview app logs are typically `~/.local/state/warp-terminal-preview/warp_preview.log*`
|
||||
- If the exact channel is unclear, ask the user to open the nearest `warp*.log*` files under `~/.local/state/`
|
||||
|
||||
Windows paths:
|
||||
|
||||
- Logs live under Warp's local app data state directory.
|
||||
- Stable app logs are typically `%LOCALAPPDATA%\warp\Warp\data\logs\warp.log*`
|
||||
- Preview app logs are typically `%LOCALAPPDATA%\warp\WarpPreview\data\logs\warp_preview.log*`
|
||||
- If the exact channel is unclear, ask the user to look under `%LOCALAPPDATA%\warp\` for the relevant `Warp*` folder and attach the matching `warp*.log*` files from its `data\logs\` directory
|
||||
|
||||
If no artifacts are available, say so plainly instead of implying they were checked.
|
||||
@@ -0,0 +1,29 @@
|
||||
# Platform Guidance
|
||||
|
||||
Use this only when the operating system, Warp version, or operating-system-specific behavior is relevant and missing.
|
||||
|
||||
- Resolve the execution surface first: packaged native Warp app or web session.
|
||||
- Prefer the bundled helper scripts and metadata files over prose or ad hoc shell inspection.
|
||||
- If the user already gave a sufficiently specific OS version or Warp version, do not ask again.
|
||||
- Include both OS name and version in the `Operating system` section when available.
|
||||
- Include the `Warp version` section when available, and note when the report is about a web session rather than a packaged native install.
|
||||
|
||||
## Operating system
|
||||
|
||||
Resolve the OS from the machine where the reported behavior actually happens. Do not substitute the OS of a different host, container, or remote target unless that is where the bug occurs.
|
||||
Run the bundled helper script when you need to resolve OS name and version:
|
||||
|
||||
```bash
|
||||
python3 scripts/resolve_platform.py
|
||||
```
|
||||
|
||||
Use the script output directly when filling `Operating system`. Ask the user only if Python is unavailable or the output still does not identify the relevant environment precisely enough.
|
||||
|
||||
## Warp version
|
||||
|
||||
For packaged native Warp installs, read the bundled version metadata file directly:
|
||||
The bundled version metadata file lives at `../../metadata/version.json` relative to the skill root. Read its `warp_version` field and use that value directly.
|
||||
|
||||
Use the file contents directly when filling `Warp version`. Ask the user only if Python is unavailable, the bundled metadata file is missing or unreadable, or the report is about a browser or web session rather than a packaged native install.
|
||||
|
||||
- Browser or web session with no local Warp executable: use the version or build identifier from the session URL or surrounding session metadata when present. If there is no concrete version string, record that it was a web session and leave `Warp version` as `Unknown` rather than guessing.
|
||||
Reference in New Issue
Block a user