title | intro | permissions | redirect_from | versions | topics | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Creating a pull request |
Create a pull request to propose and collaborate on changes to a repository. These changes are proposed in a *branch*, which ensures that the default branch only contains finished and approved work. |
Anyone with read access to a repository can create a pull request. {% data reusables.enterprise-accounts.emu-permission-propose %} |
|
|
|
If you want to create a new branch for your pull request and do not have write permissions to the repository, you can fork the repository first. For more information, see "AUTOTITLE" and "AUTOTITLE."
You can specify which branch you'd like to merge your changes into when you create your pull request. Pull requests can only be opened between two branches that are different.
{% data reusables.pull_requests.perms-to-open-pull-request %}
{% data reusables.pull_requests.close-issues-using-keywords %}
By default, pull requests are based on the parent repository's default branch. For more information, see "AUTOTITLE."
If the default parent repository isn't correct, you can change both the parent repository and the branch with the drop-down lists. You can also swap your head and base branches with the drop-down lists to establish diffs between reference points. References here must be branch names in your GitHub repository.
When thinking about branches, remember that the base branch is where changes should be applied, the head branch contains what you would like to be applied.
When you change the base repository, you also change notifications for the pull request. Everyone that can push to the base repository will receive an email notification and see the new pull request in their dashboard the next time they sign in.
When you change any of the information in the branch range, the Commit and Files changed preview areas will update to show your new range.
{% tip %}
Tips:
- Using the compare view, you can set up comparisons across any timeframe. For more information, see "AUTOTITLE."
- Project maintainers can add a pull request template for a repository. Templates include prompts for information in the body of a pull request. For more information, see "AUTOTITLE."
{% endtip %}
{% webui %}
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.new-pull-request %}
- Use the base branch dropdown menu to select the branch you'd like to merge your changes into, then use the compare branch drop-down menu to choose the topic branch you made your changes in. {% data reusables.repositories.pr-title-description %} {% data reusables.repositories.create-pull-request %}
{% data reusables.repositories.asking-for-review %}
After your pull request has been reviewed, it can be merged into the repository.
{% endwebui %}
{% cli %}
{% data reusables.cli.cli-learn-more %}
To create a pull request, use the gh pr create
subcommand.
gh pr create
To assign a pull request to an individual, use the --assignee
or -a
flags. You can use @me
to self-assign the pull request.
gh pr create --assignee "@octocat"
To specify the branch into which you want the pull request merged, use the --base
or -B
flags. To specify the branch that contains commits for your pull request, use the --head
or -H
flags.
gh pr create --base my-base-branch --head my-changed-branch
To include a title and body for the new pull request, use the --title
and --body
flags.
gh pr create --title "The bug is fixed" --body "Everything works again"
To mark a pull request as a draft, use the --draft
flag.
gh pr create --draft
To add a labels or milestones to the new pull request, use the --label
and --milestone
flags.
gh pr create --label "bug,help wanted" --milestone octocat-milestone
To add the new pull request to a specific project, use the --project
flag.
gh pr create --project octocat-project
To assign an individual or team as reviewers, use the --reviewer
flag.
gh pr create --reviewer monalisa,hubot --reviewer myorg/team-name
To create the pull request in your default web browser, use the --web
flag.
gh pr create --web
{% endcli %}
{% desktop %}
-
Click Preview Pull Request. {% data variables.product.prodname_desktop %} will open a preview dialog showing the diff of the changes between your current branch and the base branch.
{% mac %}
{% endmac %}
{% windows %}
{% endwindows %}
Alternatively, to go straight to {% data variables.product.prodname_dotcom %} to create your pull request, select the dropdown icon and click Create Pull Request.
-
Confirm that the branch in the base: dropdown menu is the branch where you want to merge your changes.
{% data variables.product.prodname_desktop %} will advise you whether the current branch can be automatically merged into the base branch.
-
Click Create Pull Request. {% data variables.product.prodname_desktop %} will open your default browser to take you to {% data variables.product.prodname_dotcom %}. {% data reusables.repositories.pr-title-description %} {% data reusables.repositories.create-pull-request %}
{% enddesktop %}
{% ifversion fpt or ghec %}
{% codespaces %}
- Once you've committed changes to your local copy of the repository, click the Create Pull Request icon.
- Check that the local branch and repository you're merging from, and the remote branch and repository you're merging into, are correct. Then give the pull request a title and a description.
- Click Create.
For more information on creating pull requests in {% data variables.product.prodname_github_codespaces %}, see "AUTOTITLE."
{% endcodespaces %}
{% endif %}