Skip to content

Creating pull requests

What is a pull request?

A pull request (PR) is used to propose merging new changes saved in one branch into another branch. In other words, you file a PR to request that your code be pulled into another branch. In most cases, PRs are used to merge in changes from a feature branch into the main branch of the repository.

You can file PRs on GitHub and request review to ultimately be able to merge your code. The following components will be present in each PR:

  • A summary of line-by-line differences between the feature branch and the main branch, created by GitHub.
  • A summary, written by the contributor, describing the contents of changes proposed in the pull request.
  • A history of all commits made on the feature branch, created by GitHub.

Learn more about pull requests

For more details on pull requests, see:

Using pull requests in OpenScPCA

Once you have created a feature branch and committed changes to that branch, you will file a PR to merge those changes into the main branch of AlexsLemonade/OpenScPCA-analysis.

  • Each PR contains a group of related changes to the code.
  • Each PR includes a description of the changes made.
  • All PRs are reviewed by at least one Data Lab staff member before they can be approved. Once approved, a Data Lab staff member will merge your feature branch into the main branch of AlexsLemonade/OpenScPCA-analysis.

The pull request review process

The PR review process

We require that at least one Data Lab staff member review the content of all PRs. We will review your code contribution by:

  • Checking for correctness, clarity, and reproducibility in the code
  • Evaluating methods and rationale for any proposed analysis
  • Ensuring that all necessary documentation is present and clear

If the reviewer has comments or requests changes, you should address those comments before requesting a second review. Bear in mind that it is normal and expected for a pull request to undergo multiple rounds of review before it is approved. Once the reviewer is happy with the changes, they will approve the pull request and merge.

Then, your code contributions will be present in the main branch of AlexsLemonade/OpenScPCA-analysis 🎉 !