Maintainer Guidelines#

This document provides guidelines and tools for Gazebo maintainers.

Backporting#

When a pull request is merged into the main development branch or a stable branch, it may be necessary to backport or forward-port it to other supported (non-EOL) collections if it fixes a bug or adds a non-breaking feature. Even when a PR is merged into an older stable branch, we still use the @mergifyio backport command to propagate it forward to newer branches including main.

Important

When merging a PR that will be backported or forward-ported, you must use “Rebase and merge”. This ensures a cleaner git history and properly maintains the original author’s commit attribution across branches.

To port a merged PR to other branches, we use Mergify. You can comment on the PR with the @mergifyio backport <branches...> command. The tool below helps you quickly generate the correct Mergify command for any given PR by fetching the PR’s target branch and looking up all other supported collection branches in gz-collections.yaml.

Generate Mergify Backport Command