Skip to content

Filing a pull request

Once you have committed changes to your feature branch and pushed to origin, you are ready to file a PR.

Don't know what to include in your PR or when to file a PR? See our guidelines on scoping a PR!

More information on filing a pull request

For more on filing a pull request, see the GitHub documentation on filing a PR.

How to file a pull request for OpenScPCA

You should always file PRs from your feature branch in your fork to the main branch of AlexsLemonade/OpenScPCA-analysis. Filing a PR is the only way to incorporate any new analysis or code changes into the main code base of OpenScPCA.

Tip

Make sure you have followed the steps outlined in Before you file a pull request prior to following the instructions here.

Follow the below steps to file a pull request on GitHub:

  1. Commit all changes you plan to include in your PR to your feature branch.

  2. Push all commits to origin, ensuring that all commits are saved to the remote copy of your feature branch.

  3. Navigate to your fork of the OpenScPCA repository on GitHub.

    Once there, use the drop-down menu on the top left to select the feature branch you would like to file the PR from. This will re-load the page and now display the contents of your feature branch.

    Change branch

  4. Click on the Contribute button next to the Sync Fork button, and select Open pull request. Any changes found in your feature branch that are not in the main branch of AlexsLemonade/OpenScPCA-analysis will be included in the PR.

    Contribute

  5. GitHub will then redirect you to the page where you can file your PR. On this page, you should see:

    • The base repository should be AlexsLemonade/OpenScPCA-analysis.
      • The base field should be main.
      • This is the branch you are proposing to merge your changes into.
    • The head repository should be your fork, username/OpenScPCA-analysis.
      • The compare field should be your feature branch (here, username/42-celltype-ewings).
      • This is the branch with the changes you would like to merge into OpenScPCA's main code base.

    Check branches

    If you do not see a green check mark with the words Able to merge, but instead see a red X and a warning stating Merge conflicts detected, you will need to resolve merge conflicts before you can file the PR.

  6. Be sure to provide a descriptive title summarizing your changes and fill out the PR template.

    Please follow the instructions in the template and fill it out to completion.

    Title and template

    Remember, you can always scroll down to below the template and check the contents of your PR look as expected. This will show you the history of commits, the number of lines changed, and the line-by-line changes in the code. This can also be helpful in ensuring your PR fits our recommendation of 400 lines or less.

  7. Once you have completed the PR template, you can press Create pull request.

    After filing your PR, the Data Lab team will review the proposed changes before changes can be merged into the main code base.

    • You will be able to make additional commits to your feature branch, even after filing your PR.
    • Every time you make a new commit and push to origin, it will now be reflected in your PR.
    • This is particularly helpful when making changes in response to review comments.

You have now successfully created a pull request!