Skip to content

create-pr.md

Latest commit

 

History

History
39 lines (31 loc) · 2.44 KB

create-pr.md

File metadata and controls

39 lines (31 loc) · 2.44 KB

Create PR

Overview

Create a well-structured pull request with proper description, labels, and reviewers.

Steps

Note in the command output, format all URLs as clickable Markdown links: [Link Text](URL)

  1. Check that the pull request is not already open in the remote repository

    • If it is opened, write only PR summary (see step 3) and skip all other steps

  2. Prepare branch

    • Ensure all changes are committed
    • Push branch to remote
    • Verify branch is up to date with main

  3. Write PR description

    • Use template from ./docs/PULL_REQUEST_TEMPLATE.md
    • Check if the branch name contains an issue number (use the regexp /issue-\d+/)
      • If found, fetch the issue details using gh issue view [issue_number]
      • Include "Resolves #[issue_number]" at the very beginning of the description (in the "Description and Related Issue(s)" section)
    • Summarize the changes clearly and concisely, using no more than two paragraphs. If necessary, use bullet points to highlight the main changes in the codebase. Be precise, this description should not be very long.
    • List any changes in the environment variables (look at the ./docs/ENVS.md file) in a separate section, describe purpose of each variable change
      • Bad example: "Added NEXT_PUBLIC_VIEWS_TX_GROUPED_FEES environment variable to the documentation"
      • Good example: "Added NEXT_PUBLIC_VIEWS_TX_GROUPED_FEES to group transaction fees into one section on the transaction page"
      • Good example: "Extended possible values for NEXT_PUBLIC_VIEWS_TX_ADDITIONAL_FIELDS with set_max_gas_limit to display the maximum gas price set by the transaction sender"
      • Good example: "Introduced a new option, "fee reception", for the NEXT_PUBLIC_NETWORK_VERIFICATION_TYPE variable"
    • Keep the "Checklist for PR Author" section and check the appropriate items in it.
    • When finished, ask the user for confirmation or changes before moving on to the next step.

  4. Set up PR

    • Create a pull request with a descriptive title. Use draft mode for the pull request if specified in the prompt.
    • Add appropriate labels
      • If something has added or changed in ./docs/ENVS.md file, add label "ENVs"
      • If the package.json file has changed, add label "dependencies"
      • If the branch name has the issue number (use the regexp /issue-\d+/), copy all tags from the related issue
    • Include a link to the created pull request in the command output.