autowarefoundation / autoware-documentation

https://autowarefoundation.github.io/autoware-documentation/
Apache License 2.0
74 stars 141 forks source link

Establish and document the versioning system for the autoware_msgs #379

Open xmfcx opened 1 year ago

xmfcx commented 1 year ago

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 with autoware_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

Possible approaches

  1. Semantic Versioning (SemVer): Implement Semantic Versioning (major.minor.patch), providing clarity about backward compatibility and allowing easier integration for packages interacting with autoware_msgs.

  2. 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

xmfcx commented 1 year ago

I will create a PR to start with, any opinion is welcome before or during the PR.

stale[bot] commented 1 year ago

This pull request has been automatically marked as stale because it has not had recent activity.