π¨ The ultimate agentic social media scheduling tool π€
TypeScript nextjsopen-sourceopen-source-social-media-scheduling-toolosspostiz-cloudpostiz-hostedredisscheduling-toolsocial-media-scheduling-tooltypescript
feat: enforce QA section in PR descriptions with detailed guidelines
Enno Gelhausbade093dcd36
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.mdindex 0ecbb2ab2..d00de7e91 100644--- a/.github/PULL_REQUEST_TEMPLATE.md+++ b/.github/PULL_REQUEST_TEMPLATE.md@@ -12,6 +12,19 @@ Please link to related issues when possible, and explain WHY you changed things,eg: Did you discuss this change with anybody before working on it (not required, but can be a good idea for bigger changes). Any plans for the future, etc?+## QA++<!--+Write the steps here, replacing this whole comment. Leaving it as is, or writing+"N/A" / "TBD" / an empty checkbox, counts as no QA at all.++Example of what it should look like:++1. Link a webhook endpoint pointing at http://localhost:9999 (nothing listening)+2. Approve an application to trigger a delivery+3. Delivery should show 4 attempts, roughly 1m / 5m / 30m apart, then stop+-->+# Checklist:Put a "X" in the boxes below to indicate you have followed the checklist;@@ -21,3 +34,4 @@ Put a "X" in the boxes below to indicate you have followed the checklist;- [ ] I confirm I have not used AI to submit this PR or generate code for it.- [ ] I checked that there were no similar issues or PRs already open for this.- [ ] This PR fixes just ONE issue+- [ ] I have filled in the QA section above with real steps to verify this change.diff --git a/CLAUDE.md b/CLAUDE.mdindex 270401799..ea83daae6 100644--- a/CLAUDE.md+++ b/CLAUDE.md@@ -62,6 +62,10 @@ const useCommunity = () => {- Never use RAW SQL queries, always use Prisma.- The system is in production with many users, if you want to change something, you need to be sure that you are not breaking anything for existing users and a migration might be needed- Whenever you generate a PR, PR description, or similar, **always** follow the PR Template (.github/PULL_REQUEST_TEMPLATE.md)+- Every PR description **must** contain a `## QA` section with real, numbered steps a reviewer can follow to verify the change (setup, action, expected result), written so they can be run without asking the author anything. This is not optional and applies to humans and agents alike, including one-line fixes. The section is extracted verbatim and shown on the review board, so:+ - Use the exact heading `## QA` (`## Testing`, `## Test plan`, `## How to test`, `## How to verify`, `## Verification`, `## Steps to test` and `## Manual testing` are also recognised, but prefer `## QA`). The whole heading must match, so something like `## Testing philosophy` is not picked up.+ - Never leave the template placeholder in place, and never write `N/A`, `TBD`, `todo`, `none` or an empty checkbox there - those all count as no QA at all and the board will show the PR as missing testing notes.+ - Steps inside a fenced code block are ignored, so keep them as plain numbered lines.- Avoid as much as possible creating new files with pure logic of algorithms, it's usually wrong- When you write code, make sure that what you add looks like something similar somewhere else in the code, don't make weird patterns- When you finished running, run another agents that matches the new code with the existing system code, to see that it looks similar and is not a weird pattern.