From 7c48dabd9dffe592f4dc8353e23dcb04d89c85db Mon Sep 17 00:00:00 2001 From: Arjo Chakravarty Date: Mon, 17 Feb 2025 11:12:44 +0800 Subject: [PATCH] Put in a note about base-branch policies. This is useful for first time contributors and contributors who may not be able to attend PMC meetings as its hard to keep track of what our latest policies are. Signed-off-by: Arjo Chakravarty --- PULL_REQUEST_TEMPLATE.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index 0340421..181211e 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -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. +- 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-N as the base. --> # 🦟 Bug fix