Preparing a Pull Request¶
After adding a new feature or implementing a bug fix, you will probably want to merge your fix into the garage master branch and make it available to others. This page will guide you through the process of creating a pull request and merging your changes.
Assuming you read and followed the Git Workflow guide,
you’re almost ready to submit a PR. You should make sure your feature branch is
rebased on to the latest version of
rlworkgroup/master and that your
pre-commit hooks pass, then run the test suite as shown below.
Passing the Test Suite¶
Before submitting a PR, you should make sure that your changes do not cause any breakages in the garage codebase. We do this by running the test suite, which includes all the unit and integration tests that exist on the master branch, plus any new ones you added. You can run the test suite locally from the garage root directory by running
This will run the test suite in a Docker container, so be sure to have Docker installed. Also note that this will run all tests, including ones that require a MuJoCo license. If you want to skip the mujoco tests, you can manually build and run a Docker container and run specific tests from within it. See the documentation on running garage with Docker for more information.
Submitting a PR¶
Once you’ve completed the above steps, you are ready to submit a PR. First push your updated feature branch to your GitHub fork:
git push origin your-feature-branch
Then, navigate to your GitHub fork, switch to your feature branch, and click on
pull-request. On the next page, select
rlworkgroup/garage as the base
repository and your feature branch as the head repository. This will submit a
PR to merge your changes into the base repository. If the changes shown look
good, you can submit your PR.
Tags allow you to specify the scope of your PR and give readers an idea of the
nature of the changes introduced. For example, a PR containing a bug
fix should be tagged
bug, and possibly a
the fix should be backported to an older release.
Other tags, such as
ready-to-merge, can be used to invoke the Mergify bot.
The bot will automatically attempt to merge PRs that have te
label assigned, so it should only be assigned if the PR has been approved and
passes the required checks.
If your changes include bug fixes that should be made available on previous releases of garage, you should backport them. This simply means creating a PR to merge your changes into a release branch. For example, to merge your changes into the 2019.10 release, select the release-2019.10 branch as the base instead of master.
Managing a PR¶
Passing the Checks¶
After submitting a PR, you should check to make sure all the required checks pass. These checks include a CI, which runs the garage test suite, and a Codecov test, which checks that your code meets the minimum required code coverage threshold.
If any of the tests in the test suite fail, navigate to the Travis CI run for your PR by clicking on that test. The CI will include a log that specifies which tests failed, along with the stacktrace corresponding to the issue.
In some cases, tests on external PRs fail due to access limitations that prevent some tests from running. If your code coverage percentage is inexplicably low, mention this in a comment on your PR page.
If there are merge conflicts between your incoming commits and the master branch - will point them out to you at the bottom of the PR page - or if your branch does not contain the latest commits made to master, you can attempt to rebase directly on GitHub by using the Mergify bot. Submit a comment to your PR with the following:
This invokes the bot and will attempt to do a rebase. If this fails, you will have to rebase manually on your local and update your fork. See the Git Worklow documentation for details on how to do this.
This page was authored by Mishari Aliesa (@maliesa96).