From d6093d8aa2b0cbc177b116a0dc9af192249847d6 Mon Sep 17 00:00:00 2001 From: Steve Peters Date: Fri, 14 Feb 2025 11:37:02 -0800 Subject: [PATCH 1/2] Update guidance on choosing a base branch Signed-off-by: Steve Peters --- contributing.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/contributing.md b/contributing.md index d2e17cdadb..506af8a91e 100644 --- a/contributing.md +++ b/contributing.md @@ -162,10 +162,20 @@ get acquainted with this development process. 1. **Choose a base branch.** - If your changes will break API or ABI, then base your new branch off of `main`. + If this package's `main` branch is not part of the upcoming Gazebo collection, + create an issue on the package repository asking its `main` branch to be added + to the next collection. + For example, at the time this documentation is being written the upcoming Jetty + collection is [using the gz-cmake4 branch](https://github.com/gazebo-tooling/gazebodistro/blob/bc0de6a86d6ab84106f208395969353d43b18dac/collection-jetty.yaml#L6) + rather than `main`. - If you are making interdependent changes to multiple repositories without - breaking API or ABI, it is also recommended to base your new branches off of `main` - to simplify automated testing of the changes and the review process. Your - changes may be backported to an existing release once all the changes + 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](https://github.com/gazebo-tooling/gazebodistro/blob/master/collection-jetty.yaml). + 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 From 0c7fca6b8c5f9fa92e513eeb2f4f6e4e42e55e4d Mon Sep 17 00:00:00 2001 From: Steve Peters Date: Fri, 14 Feb 2025 12:04:59 -0800 Subject: [PATCH 2/2] Update contributing.md Co-authored-by: Ian Chen Signed-off-by: Steve Peters --- contributing.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/contributing.md b/contributing.md index 506af8a91e..b4912e34fb 100644 --- a/contributing.md +++ b/contributing.md @@ -167,7 +167,8 @@ get acquainted with this development process. to the next collection. For example, at the time this documentation is being written the upcoming Jetty collection is [using the gz-cmake4 branch](https://github.com/gazebo-tooling/gazebodistro/blob/bc0de6a86d6ab84106f208395969353d43b18dac/collection-jetty.yaml#L6) - rather than `main`. + rather than `main`, which means gz-cmake's `main` branch is actually not part + of a collection yet. - 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