@@ -105,10 +105,54 @@ tests/ # Python unittest tests
105105
106106** TRUST THESE INSTRUCTIONS** : Only search if instructions are incomplete or incorrect. Commands here are validated and work.
107107
108+ ## Pull Request Guidelines
109+
110+ When creating or updating pull requests, follow these requirements:
111+
112+ ** Always Include QA Steps** :
113+ - Every PR description ** must** include clear "How to QA" instructions
114+ - QA steps should be specific, actionable, and enable reviewers to verify the changes
115+ - Include all necessary setup steps (e.g., environment variables, database setup, specific URLs to visit)
116+ - For UI changes: Specify what to click, what to look for, and expected behavior
117+ - For API changes: Include example requests/responses or curl commands
118+ - For bug fixes: Include reproduction steps for the original issue and how to verify it's fixed
119+ - For refactoring: Explain how to verify behavior hasn't changed (e.g., which tests to run)
120+
121+ ** QA Steps Format** :
122+ ``` markdown
123+ ## How to QA
124+ 1 . Build the project: ` yarn install && yarn build `
125+ 2 . Start the app: ` dotrun ` or ` SECRET_KEY=test_key yarn run serve `
126+ 3 . Navigate to: [ specific URL or path]
127+ 4 . [ Specific action to take]
128+ 5 . Verify: [ Expected outcome]
129+ 6 . [ Additional steps as needed]
130+ ```
131+
132+ ** Required Context** :
133+ - Link to the issue or card being addressed
134+ - Brief explanation of what changed and why
135+ - Any prerequisites or dependencies
136+ - Screenshots for visual changes
137+ - Warnings about breaking changes or migrations
138+
108139## Code Review Guidelines
109140
110141When reviewing pull requests, be a constructive and helpful reviewer:
111142
143+ ** Verify QA Steps (CRITICAL)** :
144+ - ** Always check** that the PR description includes "How to QA" instructions
145+ - If QA steps are missing or incomplete, request them before proceeding with review
146+ - ** Attempt to run** the QA steps whenever possible:
147+ - Follow the provided steps exactly as written
148+ - Report any steps that don't work or are unclear
149+ - Verify that the expected outcomes actually occur
150+ - Test edge cases mentioned in the QA steps
151+ - For UI changes: Follow QA steps and take screenshots to verify behavior
152+ - For API/backend changes: Run provided curl commands or test scripts
153+ - For bug fixes: Verify the original issue is resolved using the QA steps
154+ - Document your QA results in the review (e.g., "✅ Followed QA steps, verified expected behavior")
155+
112156** Verify Best Practices** :
113157- Check that code follows patterns documented in this file (build sequence, testing requirements, etc.)
114158- Ensure changes follow conventions in README.md, HACKING.md, and CONTRIBUTING.md
@@ -124,12 +168,14 @@ When reviewing pull requests, be a constructive and helpful reviewer:
124168- Don't suggest changes to areas you're uncertain about - ask questions instead
125169
126170** Highlight Areas Needing Attention** :
171+ - Point out missing or incomplete QA steps in PR descriptions
127172- Point out code that lacks tests or has insufficient test coverage
128173- Flag changes that might have security implications (authentication, data validation, etc.)
129174- Note when changes affect critical paths (authentication, payment flows, data integrity)
130175- Identify potential performance issues (N+1 queries, inefficient algorithms, large bundle sizes)
131176- Call out when assets need rebuilding (` yarn build ` after frontend/template changes)
132177- Mention when changes require documentation updates
178+ - Highlight QA steps that are unclear, missing prerequisites, or difficult to follow
133179
134180** Use Conversational Style** :
135181- Ask questions to understand the author's intent: "What's the reasoning behind this approach?"
0 commit comments