mirror of
https://github.com/stablyai/orca.git
synced 2026-11-13 17:37:40 +00:00
65 lines
3.1 KiB
Markdown
65 lines
3.1 KiB
Markdown
## ELI5
|
|
|
|
<!-- Simple high-level explanation, in plain language. No jargon. -->
|
|
|
|
## What Changed
|
|
|
|
<!-- Describe the change clearly and keep scope tight. Cover the before and after as the user experiences it, and the mechanism you changed — not just the symptom. -->
|
|
|
|
## Why
|
|
|
|
<!-- What problem does this solve, and why is this approach better than the alternatives you considered? -->
|
|
|
|
## Linked Issue
|
|
|
|
_If you do not have one and are an outside contributor, your PR **will** be ignored. Refs is not sufficient. Link an actual issue_
|
|
<!-- Link the issue this PR addresses, there should ALWAYS be one (for outside contributors) -->
|
|
<!-- SPECIAL CASE: If you are a maintainer (member of stablyai org) AVOID opening needless issues. Only attach pre-existing ones -->
|
|
|
|
Fixes #
|
|
|
|
## Visual Proof
|
|
|
|
<!-- REQUIRED for UI / behavior changes. Please attach a BEFORE and AFTER that can easily be tabbed/switched. Use videos for when appropriate over screenshots -->
|
|
<!-- If there is truly no visual or interaction change, write exactly: `N/A` and briefly say why. -->
|
|
<!-- For attachments NEVER add directly to the PR files (do not commit to files), use `gh image` extension or drag + drop (works for any attachment) -->
|
|
|
|
## Testing
|
|
|
|
<!-- How did you verify this? Steps a reviewer can follow. Which platforms did you actually test (macOS / Linux / Windows / SSH)? -->
|
|
|
|
- [ ] I manually tested these changes locally
|
|
- [ ] Automated tests added/updated, or explained why not below
|
|
- [ ] Every added test fails without this change and avoids the [test anti-patterns](https://github.com/stablyai/orca/blob/main/docs/agents-md-refs/test-antipatterns.md)
|
|
|
|
## Risk
|
|
|
|
<!-- What could this break, and for whom? Name the riskiest part of the change and what users would see if it went wrong. Call out anything that crosses a boundary: saved data or settings, older paired phones or SSH servers, other platforms, agents, or performance. Say how to back it out: a plain revert, or what a revert would not undo. -->
|
|
|
|
**Level:** <!-- Low, Medium, or High -->
|
|
|
|
## AI Disclosure
|
|
|
|
<!-- DO NOT FILL IN IF YOU ARE STABLYAI TEAM MEMBER (INTERNAL CONTRIBUTOR), IGNORE SECTION: -->
|
|
<!-- Which AI model if anyone was used, please state the details -->
|
|
|
|
## Review
|
|
|
|
## Agent skill upstream boundary
|
|
|
|
- [ ] Not applicable, or this change copies or mechanically translates no upstream skill-installer source, tests, fixtures, registry entries, path tables, comments, or documentation.
|
|
|
|
## Notes
|
|
|
|
Ensure no issues in: Security, Cross-platform support (Linux, Windows, Mac), Remote SSH, Mobile, general backwards compatibility, performance
|
|
|
|
## Checklist
|
|
|
|
- [ ] This PR is small and focused
|
|
- [ ] I explained what changed and why (ELI5, the user-facing before/after, the mechanism, and why over the alternatives)
|
|
- [ ] I stated the risk: what could break, for whom, and how to back it out
|
|
- [ ] Before/after screenshots or videos attached for UI changes, or `N/A` with reason
|
|
- [ ] Self-reviewed for correctness, security, and performance
|
|
- [ ] Cross-platform, SSH/remote, and path/shortcut impact considered (or N/A)
|
|
- [ ] `pnpm lint`, `pnpm typecheck`, `pnpm test`, and `pnpm build` pass (or CI will cover; local preferred)
|