Update guidance on choosing a base branch #574
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Steve Peters <scpeters@openrobotics.org>
iche033
reviewed
Feb 14, 2025
Co-authored-by: Ian Chen <ichen@openrobotics.org> Signed-off-by: Steve Peters <computersthatmove@gmail.com>
iche033
approved these changes
Feb 14, 2025
j-rivero
reviewed
Feb 17, 2025
| @@ -162,10 +162,21 @@ 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, | |||
There was a problem hiding this comment.
Might not be easy but I think that we should drive to simplify rules so people that read "Choose a base branch" with the intention of coding as soon as possible don't fall into too much effort to start that. This main branch procedure that is well described seems something more designed for the core team than for the newcomers.
For newcomers, different difficulties are here: what is a collection? Which is the upcoming collection nowadays? How can I check if main branch is part of any collection? Why I need to create an issue if all I what to do is to send a PR?.
| 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 |
There was a problem hiding this comment.
If we have Jetty open for development, should be fine to merge ABI/API breaking changes here?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This clarifies the guidance on choosing a base branch to recommend using the branch in the upcoming Gazebo collection instead of recommending
mainin all cases.