Skip to main content

Create PRs

Pull requests (PRs) foster collaboration within your team, ensuring code changes go through required reviews, approvals, and checks before being merged to the base branch.

Create a pull request​

  1. In your repository, go to Pull Requests and select New Pull Request.

  2. Select the base branch and the compare branch, which is the branch that you want to merge into the base branch.

  3. You can edit the Title and enter a Description.

  4. If this PR is ready for review, select Create pull request.

    To save a PR as a draft, select the dropdown next to Create pull request, and then select Create draft pull request.

  5. Request reviews and then merge the PR.

tip

You can also create PRs by comparing branches and when committing changes.

Compare & Pull Request Banner​

When a commit is pushed to a branch without an existing pull request, Harness Code Repository displays a banner at the top of the repository page, allowing the user to quickly create a PR from that branch.

Banner Visibility

The banner appears for 2 hours after changes are pushed to a branch. Once this time window passes, the banner no longer displays on page load.

Only the three most recently updated branches are eligible to show the banner.

Close a pull request​

If you decide a pull request is invalid or not ready for review, you can close it.

  1. In your repository, go to Pull Requests, and select the PR you want to close.
  2. Select the dropdown next to Squash and merge, and select Close pull request.
  3. Select Close pull request again to confirm the closure.

To reopen the PR, select Open for review.

Pull request templates​

Pull request templates encourage contributors to provide required and optional information in pull request descriptions.

To create a pull request template for a Harness Code repo, create a pull_request_template.md file in the repo's .harness directory, and then add your Markdown-formatted template to pull_request_template.md. For example:

## Change summary

This PR includes changes that...

## Change type

- [ ] Bug fix
- [ ] Enhancements
- [ ] Documentation
- [ ] Maintenance

## Linked issues

This PR includes changes that address the following issues/tickets:

- x
- x
- x

When a contributor opens a PR, Harness checks for pull_request_template.md in the .harness directory and populates the PR description with the template.