[X] I've searched other issues and no duplicate issues were found.
[X] I've agreed with the maintainers that I can plan this task.
Description
This proposal outlines the need for a defined versioning system for autoware_msgs. It will also cover how various packages and tools that interact with autoware_msgs can adapt to this versioning system.
cc. @mitsudome-r @isamu-takagi @wep21 @kenji-miyake @TakaHoribe @mehmetdogru @kaancolak @miursh
Purpose
Establish a robust version control mechanism for autoware_msgs to improve source control and make updates transparent and trackable.
Define a transition process for tools/packages that interact with autoware_msgs to adapt to changes or updates, ensuring smooth integration and avoiding potential conflicts.
Create a solid foundation for future development and expansion of the autoware_msgs package.
Possible approaches
Semantic Versioning (SemVer): Implement Semantic Versioning (major.minor.patch), providing clarity about backward compatibility and allowing easier integration for packages interacting with autoware_msgs.
Release Branching: Create release branches for autoware_msgs for each major version. This allows for bug fixes and minor updates to be added to previous versions without disturbing the main development.
Definition of done
[ ] A comprehensive document outlining the chosen versioning system and the rationale behind it is drafted.
[ ] Autoware developers have reviewed and approved the proposal.
[ ] The document is merged into the project repository as an official guide for autoware_msgs versioning system.
Checklist
Description
This proposal outlines the need for a defined versioning system for
autoware_msgs
. It will also cover how various packages and tools that interact withautoware_msgs
can adapt to this versioning system.This proposal serves as a follow-up from:
cc. @mitsudome-r @isamu-takagi @wep21 @kenji-miyake @TakaHoribe @mehmetdogru @kaancolak @miursh
Purpose
autoware_msgs
to improve source control and make updates transparent and trackable.autoware_msgs
to adapt to changes or updates, ensuring smooth integration and avoiding potential conflicts.autoware_msgs
package.Possible approaches
Semantic Versioning (SemVer): Implement Semantic Versioning (major.minor.patch), providing clarity about backward compatibility and allowing easier integration for packages interacting with
autoware_msgs
.Release Branching: Create release branches for
autoware_msgs
for each major version. This allows for bug fixes and minor updates to be added to previous versions without disturbing the main development.Definition of done
autoware_msgs
versioning system.