Opening a Pull Request

When a branch is ready to be reviewed for integration into the main or develop branches follow the steps below to open a pull request:

  1. Browse to https://github.com/LLNL/sundials

  2. Click on the branch icon on the left side of screen - you’ll see a list of all available branches

  3. Click on your branch - you’ll see a ‘Compare’ screen that lets you pick a branch (source on top) to merge with another branch (target on bottom)

  4. Select the desired branches and click ‘Create pull request’

  5. Edit the title of the pull request (defaults to branch name), add a description, and select reviewers that can approve the request

  6. Click ‘Create’

The selected reviewers will go over the changes in the pull request and may ask for additional changes before merging the branch. After the pull request is merged, delete the local copy the branch:

$ git checkout PARENT
$ git branch -D <branch-name>

Note

When you open a PR, various “checks” will run on your code. You can see the status of these checks at the bottom of the PR page on GitHub. Any fixes needed to pass the checks for formatting, spelling, and SWIG updates can be downloaded as git patches under “artifacts”. These patches can be applied to your branch using git apply <patch> and then committed.

Warning

Almost all pull requests should be issued against the develop branch. Generally, the only branches we merge to main are special PRs to synchronize develop and main.