j3soon/ros2-essentials

Clean Up Codebase

j3soon opened this issue · 1 comments

j3soon commented

Somethings that needed to be cleaned up across the entire code base in the future.

  • (2024/07/29 Done) docker-compose -> docker compose
  • (2024/07/05 Moved to Issues) Change gazebo cache dir mount with persistent cache volume? (reuse cache across workspaces)
  • (2024/08/06 Moved to Issues) Add some checking scripts to ensure that each workspace follow similar configuration patterns (such as devcontainers settings, etc.)
  • (2024/04/29 Done) Rename repo ros2-agv-essentials -> ros2-essentials.
  • (2024/08/06 Moved to Issues) Rename docs ros2-agv-essentials -> ros2-essentials.
  • (Done) Don't couple the docker installation guide in this repo (link to another doc/repo)
  • (2024/08/06 Moved to Issues) Remove the version line in compose files. See this and this.
  • (2024/08/06 Moved to Issues) Improve license
  • (2024/08/06 Moved to Issues) Advanced docker compose yaml configurations such as fragments, extensions, and more.
  • (2024/08/06 Checked) Try to use git checkout instead of git reset --hard when possible. Ref: https://git-scm.com/book/en/v2/Git-Tools-Reset-Demystified#_without_paths
j3soon commented

In the future, each modification should be isolated into its own issue. Opening a new issue is free after all.