Skip to content

Commit 7be75cb

Browse files
authored
contributing.md: suggest multi-repo features target main (#440)
Signed-off-by: Steve Peters <scpeters@openrobotics.org>
1 parent 7c37384 commit 7be75cb

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

contributing.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -183,8 +183,14 @@ get acquainted with this development process.
183183
take place in your fork.
184184
- An important thing to do is create a remote pointing to the [upstream remote repository](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork). This way, you can always check for modifications on the original repository and **always** keep your fork repository up to date.
185185

186-
1. **Choose a base branch.** If your changes will break API or ABI, then
187-
base your new branch off of `main`. If your changes don't break
186+
1. **Choose a base branch.**
187+
- If your changes will break API or ABI, then base your new branch off of `main`.
188+
- If you are making interdependent changes to multiple repositories without
189+
breaking API or ABI, it is also recommended to base your new branches of of `main`
190+
to simplify automated testing of the changes and the review process. Your
191+
changes may be backported to an existing release once all the changes
192+
have been merged.
193+
- If your changes don't break
188194
API/ABI and you would like them to be released to an existing release
189195
with major version `N`, then use branch `gz-<library>N` as the base.
190196

0 commit comments

Comments
 (0)