Skip to content

Put in a note about base-branch policies.#12

Open
arjo129 wants to merge 1 commit intomainfrom
docs/update_pr_template
Open

Put in a note about base-branch policies.#12
arjo129 wants to merge 1 commit intomainfrom
docs/update_pr_template

Conversation

@arjo129
Copy link
Contributor

@arjo129 arjo129 commented Feb 17, 2025

🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸

🎉 New feature

Closes #

Summary

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.

Test it

Checklist

  • Signed all commits for DCO
  • Added tests
  • Added example and/or tutorial
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • Consider updating Python bindings (if the library has them)
  • codecheck passed (See contributing)
  • All tests passed (See test coverage)
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining Signed-off-by messages.

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 <arjoc@intrinsic.ai>
@azeey azeey requested review from azeey and scpeters February 19, 2025 21:02
- 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-<library>N as the base.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should encourage the default branch in this case and backport. Once we get gazebo-tooling/release-tools#1403 closed, main will be the default branch.

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A lot of this is covered in https://gazebosim.org/docs/latest/contributing/. Should we just point to that instead and update that as necessary?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants