Pull Request for new vehicle
Hi all, I'm getting ready to create a pull request to add support for the Toyota eTNGA platform vehicles, specifically the Toyota bZ4X and Subaru Solterra. I’ve been developing this in my fork for quite some time, and I want to make sure the structure of the PR aligns with the project’s standards and expectations. Given the length of time this has been in development, I’m seeking any advice or guidance on best practices for structuring the pull request or specific areas that might need special attention. I’d appreciate any input that can help streamline this process and ensure a smooth integration.
Solterra, sounds great, looking forward to your PR. Basic requirements for the vehicle code and name spaces are still the same as documented in the developer guide. Missing there is only the cmake preparation (for IDF5), best to take an existing vehicle module as an example. Check list for the pull request: * Manual page included and manual building via sphinx without errors? ("…/docs/index.rst") * Link to that manual page added to "/README.md"? * Entry added to "changes.txt"? * Vehicle build defs added to "support/sdkconfig.default.hw31"? (no longer strictly needed I think -- Marc?) Also, if you need to include some framework changes, create a separate PR for those. Generally keep framework changes separate from vehicle changes in the git commits as well. Best practice is to reduce any commit to a single feature addition/change, and if your vehicle code needs a framework change, submit the framework change first. Regards, Michael Am 25.09.24 um 03:01 schrieb solterra--- via OvmsDev:
Hi all,
I'm getting ready to create a pull request to add support for the Toyota eTNGA platform vehicles, specifically the Toyota bZ4X and Subaru Solterra. I’ve been developing this in my fork for quite some time, and I want to make sure the structure of the PR aligns with the project’s standards and expectations.
Given the length of time this has been in development, I’m seeking any advice or guidance on best practices for structuring the pull request or specific areas that might need special attention.
I’d appreciate any input that can help streamline this process and ensure a smooth integration.
_______________________________________________ OvmsDev mailing list OvmsDev@lists.openvehicles.com http://lists.openvehicles.com/mailman/listinfo/ovmsdev
-- Michael Balzer * Helkenberger Weg 9 * D-58256 Ennepetal Fon 02333 / 833 5735 * Handy 0176 / 206 989 26
Do you have some details on this? Perhaps a vehicle module that has done this well for me to replicate the 'manual building via sphinx'? Thank you On 9/29/2024 3:38 AM, Michael Balzer via OvmsDev wrote:
Manual page included and manual building via sphinx without errors? ("…/docs/index.rst")
Sphinx installation guide: https://github.com/openvehicles/Open-Vehicle-Monitoring-System-3/tree/master... Simply add your index.rst, do a lokal "make html" and see if it builds without issues in your file. For a simple template, see https://github.com/openvehicles/Open-Vehicle-Monitoring-System-3/blob/master... For a more complex manual addition including multiple pages & images, see e.g. https://github.com/openvehicles/Open-Vehicle-Monitoring-System-3/tree/master... Regards, Michael Am 29.09.24 um 21:00 schrieb solterra--- via OvmsDev:
Do you have some details on this? Perhaps a vehicle module that has done this well for me to replicate the 'manual building via sphinx'?
Thank you
On 9/29/2024 3:38 AM, Michael Balzer via OvmsDev wrote:
Manual page included and manual building via sphinx without errors? ("…/docs/index.rst")
OvmsDev mailing list OvmsDev@lists.openvehicles.com http://lists.openvehicles.com/mailman/listinfo/ovmsdev
-- Michael Balzer * Helkenberger Weg 9 * D-58256 Ennepetal Fon 02333 / 833 5735 * Handy 0176 / 206 989 26
participants (2)
-
Michael Balzer -
solterra@kezarnet.com