Create pull request

After ensuring that the implemented changes pass all relevant tests and meet the contribution guidelines, you can create a pull request following the steps below.

Step 1: Merge upstream repository

Before you contribute, your changes need to incorporate the upstream main branch into your fork. This ensures that your changes are based on the latest version of the code.

To do this, enter the following commands adapted from Syncing a Fork in your terminal:

git remote add upstream <original repository URL>
git fetch upstream
git checkout main
git merge upstream/main

Step 2: Edit changelog

Add an entry to the CHANGELOG.md file describing the proposed changes.

Step 3: Create pull request

The following steps were adapted from Creating a pull request from a fork:

1. Go to the original repo at https://github.com/openproblems-bio and click New pull request.
2. On the compare page, click the link compare across forks below the title.
3. On the right side in the head section, select your fork and the correct branch.
4. Click Create pull request.
5. Give the PR a title and description.
6. Check the box Allow edits from maintainers.
7. If the PR is ready for review, click Create Pull Request. Otherwise, click the arrow next to the button and select Create Draft Pull Request.

Next steps

GitHub Actions

Whenever a pull request (including drafts) is created, a GitHub workflow will perform checks. These checks must pass before a merge can happen. If there are errors, try to fix them while waiting for a review. If a fix is not possible, leave a comment on the PR explaining the issue.

Review

Your PR will be reviewed by OpenProblems maintainers. During the review you may be asked to make changes to the code.