Skip to content

Latest commit

 

History

History
43 lines (34 loc) · 1.93 KB

File metadata and controls

43 lines (34 loc) · 1.93 KB

Contributing Guide

Спасибо! Прочитайте CODE_OF_CONDUCT.

Setup

git clone --recurse-submodules https://github.com/Mukller/fira-autonomous-rc-car
cd fira-autonomous-rc-car

Репозиторий использует git submodules (external/) — если уже склонировали без --recurse-submodules, подтяните их отдельно:

git submodule update --init --recursive

Development

  1. Feature-ветка на конкретную задачу из issues (они же — пункты roadmap в README.md)
  2. Для ROS-нод (ros_ws/) — Python 3, ROS 2. Чистую логику (без rclpy) выносить в fira_car_control/algorithms.py — так её можно тестировать без установленного ROS 2
  3. Для прошивки (firmware/) — Arduino IDE, пройти bring-up чеклист из firmware/drive_controller/README.md перед тестом на реальной машине
  4. Commit & PR

Testing

  • Синтаксическая проверка Python-кода перед коммитом: python3 -m py_compile <файл>
  • Юнит-тесты для чистой логики (ros_ws/src/fira_car_control/test/):
    cd ros_ws/src/fira_car_control
    python -m pytest test/ -v
    Требуют только opencv-python, numpy, pytest — ROS 2/rclpy не нужен
  • Тест на реальном железе — обязателен перед тем, как считать ROS-ноду/прошивку готовой (см. пометки "не проверено на реальном железе" в соответствующих файлах)
  • Не удалять пометки о непроверенном коде, пока не проверено на самом деле