Creating a pull request - RedHatInsights/red-hat-ansible-automation-platform-documentation GitHub Wiki

Creating a pull request

A pull request proposes that the changes you made to a branch in your fork be merged into a branch in the upstream repository.

Typically, when you push a local branch to your fork, the push command output displays the URL to open a pull request for that branch.

Alternatively, you can create a pull request from the Pull requests tab of the GitHub UI. This article describes how to create a pull request using the GitHub UI.

Before you create a pull request:

  • While you were working on your issue, new changes may have been merged into the upstream parent branch. To incorporate these changes, rebase your local branch against its upstream parent branch. See Keeping your repository up to date.

    $ git fetch upstream
$ git rebase upstream/main

  • Push your updated branch to your fork.

  • Build the document

  • Push the built docs to fileshare for preview

Creating the pull request in the GitHub UI

  1. In a web browser, navigate to the upstream repository on GitHub and click Pull requests.

  2. Click New pull request.

  3. Choose the source and destination branches for the pull request.

  4. Enable the Allow edits by maintainers option.

  5. Create a descriptive title for the pull request. Include the Jira issue number. You can edit this title later. If you plan to make further changes to the pull request, add "WIP Do not merge" to the beginning of the title.

  6. In the description, include:

    • A link to the Jira issue

    • The name of the books that the changes affect. Remember, if you edit a file that is used by more than one book, your changes will affect more than one book.

    • A link to the preview of the built docs

    • A detailed description of the pull request content

  7. If you plan further work on the pull request and do not want to merge it, select the Create draft pull request.

  8. Confirm that the source and destination branches for the pull request are correct.

  9. Click Create pull request or Draft pull request.

After you create a pull request:

After you submit a pull request, it will be reviewed by members of this project.

⚠️ **GitHub.com Fallback** ⚠️