Skip to content

Commit d6093d8

Browse files
authored
Update guidance on choosing a base branch
Signed-off-by: Steve Peters <[email protected]>
1 parent ed43c47 commit d6093d8

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

contributing.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -162,10 +162,20 @@ get acquainted with this development process.
162162

163163
1. **Choose a base branch.**
164164
- If your changes will break API or ABI, then base your new branch off of `main`.
165+
If this package's `main` branch is not part of the upcoming Gazebo collection,
166+
create an issue on the package repository asking its `main` branch to be added
167+
to the next collection.
168+
For example, at the time this documentation is being written the upcoming Jetty
169+
collection is [using the gz-cmake4 branch](https://github.com/gazebo-tooling/gazebodistro/blob/bc0de6a86d6ab84106f208395969353d43b18dac/collection-jetty.yaml#L6)
170+
rather than `main`.
165171
- If you are making interdependent changes to multiple repositories without
166-
breaking API or ABI, it is also recommended to base your new branches off of `main`
167-
to simplify automated testing of the changes and the review process. Your
168-
changes may be backported to an existing release once all the changes
172+
breaking API or ABI, it is recommended to base your new branches off of
173+
the branch used in the upcoming collection
174+
to simplify automated testing of the changes and the review process.
175+
For example, at the time this documentation is being written the upcoming Jetty
176+
collection branches are documented in
177+
[gazebodistro](https://github.com/gazebo-tooling/gazebodistro/blob/master/collection-jetty.yaml).
178+
Your changes may be backported to an existing release once all the changes
169179
have been merged.
170180
- If your changes don't break
171181
API/ABI and you would like them to be released to an existing release

0 commit comments

Comments
 (0)