search

ros-navigation / navigation2

ROS 2 Navigation Framework and System
https://nav2.org/
Other
2.51k stars 1.27k forks source link

Organize packages into sub directories #4381

Closed ruffsl closed 4 months ago

ruffsl commented 4 months ago

The list of packages has gotten kind of long, and while we don't expect to add many more, it already overflows my file tree view, requiring me to scroll around when bouncing between packages. This PR attempts to reorganize packages into categorized sub directories. Completely open to suggestions, as the current categorization is kind of lose for some. I'd happy with at least stuffing them into a src sub folder so I can work on peripheral files without needing scroll back and forth, but figured we could organize things further while we're at it. We also need't pigeon hole every package, and could just leave some flat under src.

Before After
split-0 split2-0
ruffsl commented 4 months ago

The current layout as of 4cfe996 :

``` $ tree -L 2 src/ src/ ├── base │ ├── nav2_bringup │ ├── nav2_common │ ├── nav2_core │ ├── nav2_msgs │ └── nav2_util ├── behaviors │ ├── nav2_behavior_tree │ ├── nav2_behaviors │ └── nav2_bt_navigator ├── controllers │ ├── nav2_controller │ ├── nav2_dwb_controller │ ├── nav2_graceful_controller │ ├── nav2_mppi_controller │ ├── nav2_regulated_pure_pursuit_controller │ └── nav2_rotation_shim_controller ├── localizers │ └── nav2_amcl ├── misc │ ├── nav2_map_server │ ├── nav2_rviz_plugins │ ├── nav2_system_tests │ └── navigation2 ├── nav2_collision_monitor ├── nav2_costmap_2d ├── nav2_lifecycle_manager ├── nav2_simple_commander ├── nav2_voxel_grid ├── nav2_waypoint_follower ├── planners │ ├── nav2_navfn_planner │ ├── nav2_planner │ ├── nav2_smac_planner │ └── nav2_theta_star_planner └── smoothers ├── nav2_constrained_smoother ├── nav2_smoother └── nav2_velocity_smoother ```
mergify[bot] commented 4 months ago

@ruffsl, your PR has failed to build. Please check CI outputs and resolve issues. You may need to rebase or pull in main due to API changes (or your contribution genuinely fails).

mergify[bot] commented 4 months ago

This pull request is in conflict. Could you fix it @ruffsl?

SteveMacenski commented 4 months ago

If there isn't strong support from other maintainers for this action, I would prefer to close this as #wont-fix. I don't personally like the reorg and if others aren't clammering for it, I'd prefer to not make any changes. Otherwise, we'd have to go back and forth on how specifically we want to organize the subdirectories which I don't feel is the best use of either of our cycles at the present

ruffsl commented 4 months ago

Ok, I'll work from an offline branch to minimize scrolling locally so I have an easier time working on top level directories.