{"action":"created","comment":{"url":"https://api.github.com/repos/ros-infrastructure/rep/pulls/comments/24481721","id":24481721,"diff_hunk":"@@ -0,0 +1,129 @@\n+REP: 144\n+Title: ROS Package Naming and Versioning\n+Author: Vincent Rabaud <vincent.rabaud@gmail.com>\n+Status: Draft\n+Type: Informational\n+Content-Type: text/x-rst\n+Created: 28-Jan-2015\n+Post-History:\n+\n+\n+Abstract\n+========\n+\n+This REP gives advice on how a ROS package should be named and versioned. It\n+formalizes and extends conventions that were formerly described in [1]_.\n+\n+Motivation\n+==========\n+\n+As the number of ROS packages increases, it is hard to quickly find a package\n+and guess its functionality based on its name. Over time, the lack of naming \n+conventions created problems like use of unexplained acronyms or\n+packages with the same functionality but different names.\n+\n+This REP proposes rules to name a ROS package properly. Those \n+rules are not mandatory, merely informative.\n+\n+\n+Package Naming\n+==============\n+\n+Global Rules\n+------------\n+\n+* ``alphanumerics`` are ``A-Za-z0-9`` only\n+* a package name is defined more strictly than with Debian at [2]_. It must only consist\n+  of lower case letters ``a-z``, digits ``0-9`` and ``_`` separators. They must be at\n+  least two characters long and must start with an alphanumeric character\n+* package names should be specific enough to identify what the package does. For example,\n+  a motion planner should not called ``planner``. If it implements the wavefront propagation\n+  algorithm, it might be called ``wavefront_planner``. There's obviously tension between\n+  making a name specific and keeping it from becoming overly verbose\n+* using catchall names such as ``utils`` should be avoided as they do not scope what goes\n+  into the package or what should be outside the package\n+* a package name should not contain ``ros`` as it is redundant. Exceptions include \n+  core packages and ROS bindings of an upstream library (e.g. ``moveit_ros``)\n+* one of ROS's goals is to develop a canonical set of tools for making robots do\n+  interesting things. The package name should describe what the package does, not where\n+  it came from\n+* to check whether a name is taken, consult [3]_. If you'd like your\n+  repository included in that list, see the tutorial at [4]_\n+\n+Naming Rules\n+------------\n+\n+The following rules define the different parts of the package name. The overall \n+idea is to prepend a name with words that distinguish it from similar \n+functional implementation (e.g.: ``lab``, ``robot``) but in order of importance \n+(e.g.: ``python_robot_lab``). Similarly, words that specialize this \n+functionality are appended (e.g. ``msgs``, ``config`` ...).\n+\n+The rules to add those words should be followed in order. For prefixes:\n+\n+* if a package is specialized by an entity (lab, company, ...), prepend the \n+  name of the entity\n+* if a package is specialized for a software project, prepend its name\n+* if a package is specialized for a hardware piece, prepend its name\n+* if a package is specialized for a robot, prepend its name\n+\n+For suffixes:\n+\n+* if a package is a driver, append ``driver``\n+* if a package contains any of a ROS message/service/action, append ``msgs``\n+* if a package is a plugin for a library, append ``library-name_plugins``, e.g. \n+  ``pr2_gazebo_plugins``\n+* if a package is meant for test only, append ``test``\n+\n+Special Suffixes:\n+\n+* a development only package, containing anything used to compile against \n+  (headers, CMake files ...) should have its name end in ``dev``\n+* a package built in debug mode should have its name end in ``dbg``\n+* a meta package for a robot should be named ``name-of-the-robot_robot``, e.g. \n+  ``pr2_robot``\n+* a package containing the URDF and meshes of a robot should be named \n+  ``name-of-the-robot_description``, e.g ``pr2_willow_garage_description``","path":"rep-0144.rst","position":86,"original_position":86,"commit_id":"6d27989b6daebc28991bbec5025e19d4575a78ee","original_commit_id":"6d27989b6daebc28991bbec5025e19d4575a78ee","user":{"login":"mintar","id":320188,"avatar_url":"https://avatars.githubusercontent.com/u/320188?v=3","gravatar_id":"","url":"https://api.github.com/users/mintar","html_url":"https://github.com/mintar","followers_url":"https://api.github.com/users/mintar/followers","following_url":"https://api.github.com/users/mintar/following{/other_user}","gists_url":"https://api.github.com/users/mintar/gists{/gist_id}","starred_url":"https://api.github.com/users/mintar/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mintar/subscriptions","organizations_url":"https://api.github.com/users/mintar/orgs","repos_url":"https://api.github.com/users/mintar/repos","events_url":"https://api.github.com/users/mintar/events{/privacy}","received_events_url":"https://api.github.com/users/mintar/received_events","type":"User","site_admin":false},"body":"Why not `pr2_description`?","created_at":"2015-02-11T09:23:18Z","updated_at":"2015-02-11T09:23:18Z","html_url":"https://github.com/ros-infrastructure/rep/pull/94#discussion_r24481721","pull_request_url":"https://api.github.com/repos/ros-infrastructure/rep/pulls/94","_links":{"self":{"href":"https://api.github.com/repos/ros-infrastructure/rep/pulls/comments/24481721"},"html":{"href":"https://github.com/ros-infrastructure/rep/pull/94#discussion_r24481721"},"pull_request":{"href":"https://api.github.com/repos/ros-infrastructure/rep/pulls/94"}}},"pull_request":{"url":"https://api.github.com/repos/ros-infrastructure/rep/pulls/94","id":28157209,"html_url":"https://github.com/ros-infrastructure/rep/pull/94","diff_url":"https://github.com/ros-infrastructure/rep/pull/94.diff","patch_url":"https://github.com/ros-infrastructure/rep/pull/94.patch","issue_url":"https://api.github.com/repos/ros-infrastructure/rep/issues/94","number":94,"state":"open","locked":false,"title":"REP about package naming conventions","user":{"login":"vrabaud","id":700766,"avatar_url":"https://avatars.githubusercontent.com/u/700766?v=3","gravatar_id":"","url":"https://api.github.com/users/vrabaud","html_url":"https://github.com/vrabaud","followers_url":"https://api.github.com/users/vrabaud/followers","following_url":"https://api.github.com/users/vrabaud/following{/other_user}","gists_url":"https://api.github.com/users/vrabaud/gists{/gist_id}","starred_url":"https://api.github.com/users/vrabaud/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/vrabaud/subscriptions","organizations_url":"https://api.github.com/users/vrabaud/orgs","repos_url":"https://api.github.com/users/vrabaud/repos","events_url":"https://api.github.com/users/vrabaud/events{/privacy}","received_events_url":"https://api.github.com/users/vrabaud/received_events","type":"User","site_admin":false},"body":"Hi, before I send that to ros-users, I'd like some early feedback as I believe I forgot some specific package types and the versioning is probably not in sync with what our infrastructure can handle.","created_at":"2015-01-28T00:09:46Z","updated_at":"2015-02-11T09:23:18Z","closed_at":null,"merged_at":null,"merge_commit_sha":"9f10a4b80d76f8495e7727004587d9e025ef1bc4","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/ros-infrastructure/rep/pulls/94/commits","review_comments_url":"https://api.github.com/repos/ros-infrastructure/rep/pulls/94/comments","review_comment_url":"https://api.github.com/repos/ros-infrastructure/rep/pulls/comments/{number}","comments_url":"https://api.github.com/repos/ros-infrastructure/rep/issues/94/comments","statuses_url":"https://api.github.com/repos/ros-infrastructure/rep/statuses/6d27989b6daebc28991bbec5025e19d4575a78ee","head":{"label":"vrabaud:master","ref":"master","sha":"6d27989b6daebc28991bbec5025e19d4575a78ee","user":{"login":"vrabaud","id":700766,"avatar_url":"https://avatars.githubusercontent.com/u/700766?v=3","gravatar_id":"","url":"https://api.github.com/users/vrabaud","html_url":"https://github.com/vrabaud","followers_url":"https://api.github.com/users/vrabaud/followers","following_url":"https://api.github.com/users/vrabaud/following{/other_user}","gists_url":"https://api.github.com/users/vrabaud/gists{/gist_id}","starred_url":"https://api.github.com/users/vrabaud/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/vrabaud/subscriptions","organizations_url":"https://api.github.com/users/vrabaud/orgs","repos_url":"https://api.github.com/users/vrabaud/repos","events_url":"https://api.github.com/users/vrabaud/events{/privacy}","received_events_url":"https://api.github.com/users/vrabaud/received_events","type":"User","site_admin":false},"repo":{"id":7779213,"name":"rep","full_name":"vrabaud/rep","owner":{"login":"vrabaud","id":700766,"avatar_url":"https://avatars.githubusercontent.com/u/700766?v=3","gravatar_id":"","url":"https://api.github.com/users/vrabaud","html_url":"https://github.com/vrabaud","followers_url":"https://api.github.com/users/vrabaud/followers","following_url":"https://api.github.com/users/vrabaud/following{/other_user}","gists_url":"https://api.github.com/users/vrabaud/gists{/gist_id}","starred_url":"https://api.github.com/users/vrabaud/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/vrabaud/subscriptions","organizations_url":"https://api.github.com/users/vrabaud/orgs","repos_url":"https://api.github.com/users/vrabaud/repos","events_url":"https://api.github.com/users/vrabaud/events{/privacy}","received_events_url":"https://api.github.com/users/vrabaud/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/vrabaud/rep","description":"","fork":true,"url":"https://api.github.com/repos/vrabaud/rep","forks_url":"https://api.github.com/repos/vrabaud/rep/forks","keys_url":"https://api.github.com/repos/vrabaud/rep/keys{/key_id}","collaborators_url":"https://api.github.com/repos/vrabaud/rep/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/vrabaud/rep/teams","hooks_url":"https://api.github.com/repos/vrabaud/rep/hooks","issue_events_url":"https://api.github.com/repos/vrabaud/rep/issues/events{/number}","events_url":"https://api.github.com/repos/vrabaud/rep/events","assignees_url":"https://api.github.com/repos/vrabaud/rep/assignees{/user}","branches_url":"https://api.github.com/repos/vrabaud/rep/branches{/branch}","tags_url":"https://api.github.com/repos/vrabaud/rep/tags","blobs_url":"https://api.github.com/repos/vrabaud/rep/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/vrabaud/rep/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/vrabaud/rep/git/refs{/sha}","trees_url":"https://api.github.com/repos/vrabaud/rep/git/trees{/sha}","statuses_url":"https://api.github.com/repos/vrabaud/rep/statuses/{sha}","languages_url":"https://api.github.com/repos/vrabaud/rep/languages","stargazers_url":"https://api.github.com/repos/vrabaud/rep/stargazers","contributors_url":"https://api.github.com/repos/vrabaud/rep/contributors","subscribers_url":"https://api.github.com/repos/vrabaud/rep/subscribers","subscription_url":"https://api.github.com/repos/vrabaud/rep/subscription","commits_url":"https://api.github.com/repos/vrabaud/rep/commits{/sha}","git_commits_url":"https://api.github.com/repos/vrabaud/rep/git/commits{/sha}","comments_url":"https://api.github.com/repos/vrabaud/rep/comments{/number}","issue_comment_url":"https://api.github.com/repos/vrabaud/rep/issues/comments/{number}","contents_url":"https://api.github.com/repos/vrabaud/rep/contents/{+path}","compare_url":"https://api.github.com/repos/vrabaud/rep/compare/{base}...{head}","merges_url":"https://api.github.com/repos/vrabaud/rep/merges","archive_url":"https://api.github.com/repos/vrabaud/rep/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/vrabaud/rep/downloads","issues_url":"https://api.github.com/repos/vrabaud/rep/issues{/number}","pulls_url":"https://api.github.com/repos/vrabaud/rep/pulls{/number}","milestones_url":"https://api.github.com/repos/vrabaud/rep/milestones{/number}","notifications_url":"https://api.github.com/repos/vrabaud/rep/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/vrabaud/rep/labels{/name}","releases_url":"https://api.github.com/repos/vrabaud/rep/releases{/id}","created_at":"2013-01-23T16:56:02Z","updated_at":"2015-01-28T00:06:45Z","pushed_at":"2015-01-28T00:06:45Z","git_url":"git://github.com/vrabaud/rep.git","ssh_url":"git@github.com:vrabaud/rep.git","clone_url":"https://github.com/vrabaud/rep.git","svn_url":"https://github.com/vrabaud/rep","homepage":null,"size":2244,"stargazers_count":0,"watchers_count":0,"language":"Python","has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"ros-infrastructure:master","ref":"master","sha":"d3ac1c7bbfa26a2497ff372aaf484827b0442ca8","user":{"login":"ros-infrastructure","id":2328632,"avatar_url":"https://avatars.githubusercontent.com/u/2328632?v=3","gravatar_id":"","url":"https://api.github.com/users/ros-infrastructure","html_url":"https://github.com/ros-infrastructure","followers_url":"https://api.github.com/users/ros-infrastructure/followers","following_url":"https://api.github.com/users/ros-infrastructure/following{/other_user}","gists_url":"https://api.github.com/users/ros-infrastructure/gists{/gist_id}","starred_url":"https://api.github.com/users/ros-infrastructure/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ros-infrastructure/subscriptions","organizations_url":"https://api.github.com/users/ros-infrastructure/orgs","repos_url":"https://api.github.com/users/ros-infrastructure/repos","events_url":"https://api.github.com/users/ros-infrastructure/events{/privacy}","received_events_url":"https://api.github.com/users/ros-infrastructure/received_events","type":"Organization","site_admin":false},"repo":{"id":5918619,"name":"rep","full_name":"ros-infrastructure/rep","owner":{"login":"ros-infrastructure","id":2328632,"avatar_url":"https://avatars.githubusercontent.com/u/2328632?v=3","gravatar_id":"","url":"https://api.github.com/users/ros-infrastructure","html_url":"https://github.com/ros-infrastructure","followers_url":"https://api.github.com/users/ros-infrastructure/followers","following_url":"https://api.github.com/users/ros-infrastructure/following{/other_user}","gists_url":"https://api.github.com/users/ros-infrastructure/gists{/gist_id}","starred_url":"https://api.github.com/users/ros-infrastructure/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ros-infrastructure/subscriptions","organizations_url":"https://api.github.com/users/ros-infrastructure/orgs","repos_url":"https://api.github.com/users/ros-infrastructure/repos","events_url":"https://api.github.com/users/ros-infrastructure/events{/privacy}","received_events_url":"https://api.github.com/users/ros-infrastructure/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/ros-infrastructure/rep","description":"ROS Enhancement Proposals","fork":false,"url":"https://api.github.com/repos/ros-infrastructure/rep","forks_url":"https://api.github.com/repos/ros-infrastructure/rep/forks","keys_url":"https://api.github.com/repos/ros-infrastructure/rep/keys{/key_id}","collaborators_url":"https://api.github.com/repos/ros-infrastructure/rep/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/ros-infrastructure/rep/teams","hooks_url":"https://api.github.com/repos/ros-infrastructure/rep/hooks","issue_events_url":"https://api.github.com/repos/ros-infrastructure/rep/issues/events{/number}","events_url":"https://api.github.com/repos/ros-infrastructure/rep/events","assignees_url":"https://api.github.com/repos/ros-infrastructure/rep/assignees{/user}","branches_url":"https://api.github.com/repos/ros-infrastructure/rep/branches{/branch}","tags_url":"https://api.github.com/repos/ros-infrastructure/rep/tags","blobs_url":"https://api.github.com/repos/ros-infrastructure/rep/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/ros-infrastructure/rep/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/ros-infrastructure/rep/git/refs{/sha}","trees_url":"https://api.github.com/repos/ros-infrastructure/rep/git/trees{/sha}","statuses_url":"https://api.github.com/repos/ros-infrastructure/rep/statuses/{sha}","languages_url":"https://api.github.com/repos/ros-infrastructure/rep/languages","stargazers_url":"https://api.github.com/repos/ros-infrastructure/rep/stargazers","contributors_url":"https://api.github.com/repos/ros-infrastructure/rep/contributors","subscribers_url":"https://api.github.com/repos/ros-infrastructure/rep/subscribers","subscription_url":"https://api.github.com/repos/ros-infrastructure/rep/subscription","commits_url":"https://api.github.com/repos/ros-infrastructure/rep/commits{/sha}","git_commits_url":"https://api.github.com/repos/ros-infrastructure/rep/git/commits{/sha}","comments_url":"https://api.github.com/repos/ros-infrastructure/rep/comments{/number}","issue_comment_url":"https://api.github.com/repos/ros-infrastructure/rep/issues/comments/{number}","contents_url":"https://api.github.com/repos/ros-infrastructure/rep/contents/{+path}","compare_url":"https://api.github.com/repos/ros-infrastructure/rep/compare/{base}...{head}","merges_url":"https://api.github.com/repos/ros-infrastructure/rep/merges","archive_url":"https://api.github.com/repos/ros-infrastructure/rep/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/ros-infrastructure/rep/downloads","issues_url":"https://api.github.com/repos/ros-infrastructure/rep/issues{/number}","pulls_url":"https://api.github.com/repos/ros-infrastructure/rep/pulls{/number}","milestones_url":"https://api.github.com/repos/ros-infrastructure/rep/milestones{/number}","notifications_url":"https://api.github.com/repos/ros-infrastructure/rep/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/ros-infrastructure/rep/labels{/name}","releases_url":"https://api.github.com/repos/ros-infrastructure/rep/releases{/id}","created_at":"2012-09-23T01:50:29Z","updated_at":"2015-01-18T22:40:27Z","pushed_at":"2015-01-26T22:14:29Z","git_url":"git://github.com/ros-infrastructure/rep.git","ssh_url":"git@github.com:ros-infrastructure/rep.git","clone_url":"https://github.com/ros-infrastructure/rep.git","svn_url":"https://github.com/ros-infrastructure/rep","homepage":"http://www.ros.org/reps/rep-0000.html","size":3052,"stargazers_count":5,"watchers_count":5,"language":"Python","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":22,"mirror_url":null,"open_issues_count":9,"forks":22,"open_issues":9,"watchers":5,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/ros-infrastructure/rep/pulls/94"},"html":{"href":"https://github.com/ros-infrastructure/rep/pull/94"},"issue":{"href":"https://api.github.com/repos/ros-infrastructure/rep/issues/94"},"comments":{"href":"https://api.github.com/repos/ros-infrastructure/rep/issues/94/comments"},"review_comments":{"href":"https://api.github.com/repos/ros-infrastructure/rep/pulls/94/comments"},"review_comment":{"href":"https://api.github.com/repos/ros-infrastructure/rep/pulls/comments/{number}"},"commits":{"href":"https://api.github.com/repos/ros-infrastructure/rep/pulls/94/commits"},"statuses":{"href":"https://api.github.com/repos/ros-infrastructure/rep/statuses/6d27989b6daebc28991bbec5025e19d4575a78ee"}}}}