starred/orca
1
0
Fork 0
mirror of https://github.com/stablyai/orca.git synced 2026-09-22 00:02:31 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ebcb2b6a60bc59d3cd4099e122584e2259931c92
orca/.github/pull_request_template.md
T
Neil ebcb2b6a60 docs: expand PR template with ELI5, before/after screenshots, and X handle 
Make the pull request template clearer for contributors: plain-language
ELI5, what/why, mandatory before/after UI proof, testing checklist, AI
disclosure, and an Author X field. Align CONTRIBUTING with the template.
2026-08-11 18:29:01 -07:00

2.9 KiB
Raw Blame History

ELI5

What Changed

Why

Linked Issue

  • Fixes #

Screenshots (required for UI / behavior changes)

Before and after are mandatory for any user-visible or UI change. Do not open a UI PR with only a description.

  • Attach a before screenshot (or short recording of the old behavior).
  • Attach an after screenshot (or short recording of the new behavior).
  • Side-by-side or labeled before/after is preferred.
  • For motion, transitions, or interactions, include a short before and after video (or one video that clearly shows both).
  • If there is truly no visual or interaction change, write exactly: No visual change and briefly say why.

Before

After

How to test

  • I manually tested these changes locally
  • Automated tests added/updated, or explained why not below

Checklist

  • This PR is small and focused
  • I explained what changed and why (including ELI5)
  • Before/after screenshots or videos attached for UI changes, or No visual change 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)

AI assistance

  • This PR was created or substantially assisted by an AI coding agent (optional disclosure)
  • I reviewed the full diff, understand every change, and can explain it in review

AI Review Report

Summarize the code review you ran with your AI coding agent. Include the main risks it checked, what it flagged, and what you changed or verified as a result. Confirm that the review explicitly checked cross-platform compatibility for macOS, Linux, and Windows, including shortcuts, labels, paths, shell behavior, and any Electron-specific platform differences touched by this PR.

Security Audit

Provide a basic security audit summary from your AI coding agent. Call out any input handling, command execution, path handling, auth, secrets, dependency, or IPC risks that were reviewed, plus any follow-up needed.

Notes

Call out any platform-specific behavior, risks, or follow-up work.

Author

  • X / Twitter: @your_handle
Reference in New Issue View Git Blame Copy Permalink