maliput / maliput/maliput_documentation

Naming inconsistency

Open
#13 1 comment 1 reaction 1 assignee Claimed by @agalbachicar View on GitHub
Dominant language
CMake
Stars
1
Forks
2
PR merge metrics
No merged PRs in 30d

Description

We have some confusing inconsistencies emerging that create build errors when expectation and usage doesn't coincide.

* Repo names use dashes (I think on all)
* Package names (in package.xml, cmake, setup.py, folders) sometimes use dashes, sometimes use underscores

I think the best practice here is to follow ROS convention. Use underscores *everywhere*. See [REP 0149#name](https://www.ros.org/reps/rep-0149.html#name). Dashes are permitted, but they are an exception to standard practice. You can see on the [foxy release page](http://repo.ros2.org/status_page/ros_foxy_default.html) that there is just one package that uses dashes.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.