broadinstitute Objective
Prepare a comprehensive, professional, and concise Pull Request description. Your goal is to fill out the project's PR template thoroughly so the reviewer can more quickly understand:
All of the bullet points below should, as a rule, be concise. One or two sentences each max.
- the intent of the PR
- the issue that this PR resolves, if applicable
- the design chosen
- what code changes/additions were required
- what tests were added, or changed
- anything that might require specific thought or consideration, and why (e.g. possible introduced breaking changes, or design of new UI components)
Workflow
1. Read the Template:
Read the .github/PULL_REQUEST_TEMPLATE.md file.
2. Determine the base:
- Ask the user if the branch is stacked off another, default to
origin/mainif the user doesn't know, as its most likely not stacked
3. Analyze the Diff
Run git diff main...HEAD to understand the holistic changes made on this branch.
4. Draft the Content
- Write a clear and concise description
- Briefly explain the architecture and design decisions, more text is a liability, be readable and to the point.
5. Check for UI Changes
Check if any changed files end in .tsx, .jsx, .css, or represent UI components.
6. Output the Draft & Prompt the User
- Output the complete, filled-out markdown for the PR.
- CRITICAL: If UI files were changed, you must add a bold note at the end telling the human: "I noticed UI changes in this branch. Please take Before/After screenshots and drag them into the table before hitting Submit."