This PR adds pre-commit hooks to the stretch_web_teleop repository. Once installed locally (pre-commit install), these hooks will automatically run before you create a commit. They will verify that you aren't committing anything that shouldn't (e.g., large files, executables without a shebang, code with misspellings), and will auto-format your code.
The main files that are changed are:
.pre-commit-config.yaml
README.md
.github/pull_request_template.md
.github/workflows/pre-commit.yaml
All other changes are re-formattings that the pre-commit hook automatically did.
Testing procedure
[x] Check that pre-commit hooks pass on this branch: Pull the code, run pre-commit run --all-files, and verify they all pass.
[x] Check that pre-commit hooks run automatically upon a PR: verify that the pre-commit hooks run on this PR.
[x] Check the entire web app (although in theory only the formatting changed, it is important to test that every aspect of the web interface still works, just to be safe): Run ./launch_interface.sh
[x] Test Camera Feeds: Verify all camera feeds are live.
[x] Test Remote Actuation:
[x] Test all buttons in the "Base" tab, verify they move the robot appropriately.
[x] Test all buttons in the "Wrist & Gripper" tab, verify they move the robot appropriately.
[x] Test all buttons in the "Arm & Lift" tab, verify they move the robot appropriately.
[x] Check Predictive Display under the overhead camera view, verify it works. Uncheck it.
[x] Try speed Slowest and Fastest, verify both work.
[x] Try Step-Actions, verify it works by clicking any of the buttons above.
[x] Try Click-Click, verify it works by clicking any of the buttons above.
[x] Test Quick Actions:
[x] Try all the options for the head camera to "Look at," verify they all work
[x] Have the head camera Follow Gripper, verify it works. Uncheck it.
[x] Add the "Realsense" Camera View with buttons, toggle on Depth Sensing, verify it works.
[x] Verify that Center Wrist and Stow Wrist work.
[x] Test Runstop: Press the run-stop button, verify it works. Press it again to disable it.
[x] Test Customization:
[x] Add the Realsense view, verify it works.
[x] Add a joystick, verify it works.
[x] Add a button grid, verify it works.
[x] Overlay a button pad on top of a camera view, verify that works.
[x] Add a "Panel", select a space for the panel, and verify all other panels resize appropriately.
[x] Test Additional Features:
[x] Load map, navigate to a goal in the map, verify that it works.
[x] Save a movement in movement recorder, then play it back, verify it works.
[x] Test Disconnects: Manually turn off/on the robot's Wifi, verify that the operator is still able to access the interface and control the robot after reconnecting.
Description
This PR adds pre-commit hooks to the
stretch_web_teleoprepository. Once installed locally (pre-commit install), these hooks will automatically run before you create a commit. They will verify that you aren't committing anything that shouldn't (e.g., large files, executables without a shebang, code with misspellings), and will auto-format your code.The main files that are changed are:
.pre-commit-config.yamlREADME.md.github/pull_request_template.md.github/workflows/pre-commit.yamlAll other changes are re-formattings that the pre-commit hook automatically did.
Testing procedure
pre-commit run --all-files, and verify they all pass../launch_interface.shPredictive Displayunder the overhead camera view, verify it works. Uncheck it.SlowestandFastest, verify both work.Step-Actions, verify it works by clicking any of the buttons above.Click-Click, verify it works by clicking any of the buttons above.Follow Gripper, verify it works. Uncheck it.Depth Sensing, verify it works.Center WristandStow Wristwork.Before opening a pull request
From the top-level of this repository, run:
pre-commit run --all-filesTo merge
Squash & Merge