VEHICLELAB

VEHICLE LAB / DOCUMENTATION

Contributing

Contributions should make an engineering question easier to investigate or its evidence easier to inspect.

A useful change

  1. State the problem, the proposed behavior and the claim boundary.
  2. Keep project data separate from shared software.
  3. Add an example or a meaningful regression check for new behavior.
  4. Run the project validator, software tests, browser checks and release scan.
  5. Include source ownership and units for any new geometry or data.
npm test
npm run test:browser
npm run check:release

Geometry and evidence

Do not include supplier CAD, copied publications, private contact details or account/session data without appropriate rights and a clear reason. Keep the model's failure and uncertainty records. A test fix must not silently turn an incomplete scenario into a pass.

Documentation

Edit the source in tools/build_docs.py, then run npm run docs. Update the project and adapter references when changing their contracts. Tutorials should be runnable from a fresh source directory.

Security reports

For a suspected vulnerability, provide the affected version, minimal reproduction and expected boundary. Exclude secrets and private files from reports. See SECURITY.md for the local server and importer threat model.