diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..016e5dd3 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,42 @@ + + +## What this is + +What changes, and `Closes #123` if there's an issue. If someone reported it, +say who and where. + +## Mechanism + +Why the old behaviour happened — the specific line, default or assumption +responsible — rather than what you did about it. If you measured something, +paste the numbers. + +## Scope + +What you deliberately left alone, and why. Anything you noticed while working +and chose not to fix here belongs in this section too. + +## Tests + +What you added or changed. For a fix: revert the fix, keep the test, and say +whether it goes red. A test that passes either way isn't testing the fix. + +## Verification + +The commands you ran and what they said — the ones CI runs are: + +``` +npm audit +npm run check +npm test +cargo test # in src-tauri/ +``` + +And what you *didn't* verify: platforms you couldn't try, paths you reasoned +about rather than ran. That's more useful to a reviewer than a list with no +gaps in it.