open-simulation-interface
open-simulation-interface copied to clipboard
Clarification static dynamic
THIS PR IS WORK IN PROGRESS AND NOT MEANT TO BE NEARLY READY FOR MERGE.
The PR should improve the information within the documentation on how often changes shall be expected. For general discussion points and Q&A, there is an Issue #770 .
Some questions to ask: What is this change? A change in the inline documentation changable data.
What does it fix? In many cases, it is unclear if data changes, or not. E.g., will the road geometry change? In the reality - probably not. Eithin the data - it could be in certain cases. This PR should give more information about where to look at and which data should be considered changeable.
Is this a bug fix or a feature? Does it break any existing functionality or force me to update to a new version? No breaking changes.
Take this checklist as orientation for yourself, if this PR is ready for the Change Control Board:
- [x] My suggestion follows the style and contributors guidelines.
- [x] I have taken care about the message documentation and the fields and enums documentation.
- [x] I have done the DCO signoff.
- [ ] My changes generate no errors when passing CI tests.
- [ ] I have successfully implemented and tested my fix/feature locally.
- [ ] Appropriate reviewer(s) are assigned.