Skip to content

Put in a note about base-branch policies. #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
arjo129 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Put in a note about base-branch policies. #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ For example, if this is a new feature, remove all sections except for the "New f

If this is your first time opening a PR, be sure to check the contribution guide:
https://gazebosim.org/docs/all/contributing

You may also want to check which base branch you wish to commit to:
- If you have a new API/ABI Breaking change or are changing the bevaviour of a system
please target the main branch.
- If you are making interdependent changes to multiple repositories without breaking API or ABI, it is recommended to base your new branches off of the branch used in the upcoming collection to simplify automated testing of the changes and the review process. For example, at the time this documentation is being written the upcoming Jetty collection branches are documented in [gazebodistro](). Your changes may be backported to an existing release once all the changes have been merged.
Copy link
Contributor

@azeey azeey Jan 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A lot of this is covered in https://gazebosim.org/docs/latest/contributing/. Should we just point to that instead and update that as necessary?

- If your changes don't break API/ABI and you would like them to be released to an existing release with major version N, then use branch gz-<library>N as the base.
Copy link
Contributor

@azeey azeey Jan 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should encourage the default branch in this case and backport. Once we get gazebo-tooling/release-tools#1403 closed, main will be the default branch.

-->

# 🦟 Bug fix
Expand Down