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

docs(contributing): state what a PR description must cover (#21080)

Browse Source 
AGENTS.md said nothing about writing PRs, and the template's section
comments could be satisfied without ever telling a reviewer what changed
for the user or which mechanism moved. Name the same four requirements in
both places: no jargon, user-facing before/after, the mechanism, and why
over the alternatives.
This commit is contained in:
Brennan Benson
2026-09-16 12:47:16 -07:00
committed by GitHub
parent 12d744f253
commit 0cd05bc3d9
2 changed files with 15 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/pull_request_template.md
+4 -4
View File
@@ -1,14 +1,14 @@
## ELI5
<!-- Simple high-level explanation -->
<!-- Simple high-level explanation, in plain language. No jargon. -->
## What Changed
<!-- Describe the change clearly and keep scope tight. -->
<!-- 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 right? -->
<!-- What problem does this solve, and why is this approach better than the alternatives you considered? -->
## Linked Issue
@@ -47,7 +47,7 @@ Ensure no issues in: Security, Cross-platoform support (Linux, Windows, Mac), Re
## Checklist
- [ ] This PR is small and focused
- [ ] I explained what changed and why (including ELI5)
- [ ] I explained what changed and why (ELI5, the user-facing before/after, the mechanism, and why over the alternatives)
- [ ] 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)