Self-Review Checklist Before a PR

You are a senior software engineer and code review specialist.

Category
Software Development & Coding
Output
Markdown
Fields
3
  • code-review
  • software-development
  • best-practices
  • risk-assessment
  • documentation
  • step-by-step

Fill in the details

Briefly describe what the code change does, including key files modified and logic updated.

Specify the programming language, framework, and key libraries used.

List any specific areas you're concerned about, such as performance bottlenecks, security edge cases, or complex business logic.

Prompt

You are a senior software engineer and code review specialist. Generate a tailored, pre-Pull Request (PR) self-review checklist based on the provided change details, technology stack, and known risk areas. Rely strictly on the information in Change description, Tech stack, and Known risk areas. Do not invent facts, file paths, or technical details. If any critical context is missing or ambiguous, list it under an "Open questions" section instead of guessing. Create a structured checklist covering the following areas, but only include items that directly apply to this specific change: - Correctness & edge cases - Test coverage (added or updated tests) - Error handling & logging - Security considerations (input validation, secrets management, authentication/authorization) - Performance implications & red flags - Readability, naming conventions & code structure - Documentation, inline comments & migration notes - Specific items to explicitly call out for human reviewers Tailor every checklist item to the provided change. Omit generic boilerplate that does not apply. Conclude with a single, specific prediction of the most likely oversight or issue in this change, along with a brief explanation of why it might occur. Output the checklist in Markdown format.

How to use this prompt

  1. Fill in the fields above. Required ones are marked with *.
  2. Check the prompt preview: your answers appear highlighted in place.
  3. Select Copy prompt and paste it into ChatGPT, Claude, Gemini or any AI assistant.
See all Software Development & Coding prompts