Skip to content

Commit c833bea

Browse files
authored
docs(vehicle_info): add docs for versioning (autowarefoundation#6069)
Signed-off-by: kosuke55 <kosuke.tnp@gmail.com> remove non-support Signed-off-by: kosuke55 <kosuke.tnp@gmail.com> fix link Signed-off-by: kosuke55 <kosuke.tnp@gmail.com> add yaml Signed-off-by: kosuke55 <kosuke.tnp@gmail.com> please check readme
1 parent 128ecc7 commit c833bea

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

vehicle/vehicle_info_util/Readme.md

+29
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,35 @@ This package is to get vehicle info parameters.
77
### Description
88

99
In [here](https://autowarefoundation.github.io/autoware-documentation/main/design/autoware-interfaces/components/vehicle-dimensions/), you can check the vehicle dimensions with more detail.
10+
The current format supports only the Ackermann model. This file defines the model assumed in autoware path planning, control, etc. and does not represent the exact physical model. If a model other than the Ackermann model is used, it is assumed that a vehicle interface will be designed to change the control output for the model.
11+
12+
### Versioning Policy
13+
14+
We have implemented a versioning system for the `vehicle_info.param.yaml` file to ensure clarity and consistency in file format across different versions of Autoware and its external applications. Please see [discussion](https://github.com/orgs/autowarefoundation/discussions/4050) for the details.
15+
16+
#### How to Operate
17+
18+
- The current file format is set as an unversioned base version (`version:` field is commented out).
19+
- For the next update involving changes (such as additions, deletions, or modifications):
20+
- Uncomment and update the version line at the beginning of the file.
21+
- Initiate versioning by assigning a version number, starting from `0.1.0`. Follow the semantic versioning format (MAJOR.MINOR.PATCH).
22+
- Update this Readme.md too.
23+
- For subsequent updates, continue incrementing the version number in accordance with the changes made.
24+
- Discuss how to increment version depending on the amount of changes made to the file.
25+
26+
```yaml
27+
/**:
28+
ros__parameters:
29+
# version: 0.1.0 # Uncomment and update this line for future format changes.
30+
wheel_radius: 0.383
31+
...
32+
```
33+
34+
#### Why Versioning?
35+
36+
- Consistency Across Updates: Implementing version control will allow accurate tracking of changes over time and changes in vehicle information parameters.
37+
- Clarity for External Applications: External applications that depend on `vehicle_info.param.yaml` need to reference the correct file version for optimal compatibility and functionality.
38+
- Simplified Management for Customized Branches: Assigning versions directly to the `vehicle_info.param.yaml` file simplifies management compared to maintaining separate versions for multiple customized Autoware branches. This approach streamlines version tracking and reduces complexity.
1039

1140
### Scripts
1241

vehicle/vehicle_info_util/config/vehicle_info.param.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
/**:
22
ros__parameters:
3+
# version: 0.1.0 # uncomment this line in the next update of this file format. please check Readme.md
34
wheel_radius: 0.39
45
wheel_width: 0.42
56
wheel_base: 2.74 # between front wheel center and rear wheel center

0 commit comments

Comments
 (0)