Contributing¶

General instructions

Regardless of the type of contribution the user has to

Improving documentation

Creating new examples

Creating new tire and vehicle models

Instructions¶

There are several ways to contribute to open source projects (Contributing to open source).

To push your contribution see the following steps:

Add and/or improve the .m files (package or examples) with codes and publishable comments.
Add the publish command of the new files to DocFiles/makeDoc.m.
Create the apropriate links between the documentation pages. Ex: “See Also”, “examples”, …
Update main.m and api.m.
Run makeDoc.m.
Commit and push.

Todo

Add illustration of the closed loop system.

(The original entry is located in /home/asm/MEGA/Repos/openvd/docs/source/exampleSteeringControl.rst, line 306.)

Todo

Improve generation of graphics. Define parameters once -> Run Simulink -> Retrieve responses -> Graphics

(The original entry is located in /home/asm/MEGA/Repos/openvd/docs/source/exampleTemplateArticulatedSimulink.rst, line 33.)

Todo

Include Template Simple Simulink Animation

(The original entry is located in /home/asm/MEGA/Repos/openvd/docs/source/exampleTemplateArticulatedSimulink.rst, line 139.)

Todo

Improve generation of graphics. Define parameters once -> Run Simulink -> Retrieve responses -> Graphics

(The original entry is located in /home/asm/MEGA/Repos/openvd/docs/source/exampleTemplateSimpleSimulink.rst, line 32.)

Todo

Include Template Articulated Simulink Animation

(The original entry is located in /home/asm/MEGA/Repos/openvd/docs/source/exampleTemplateSimpleSimulink.rst, line 123.)