-
Notifications
You must be signed in to change notification settings - Fork 141
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: update the naming rules for directories and classes #547
Conversation
Signed-off-by: M. Fatih Cırıt <[email protected]>
Signed-off-by: M. Fatih Cırıt <[email protected]>
Signed-off-by: M. Fatih Cırıt <[email protected]>
Signed-off-by: M. Fatih Cırıt <[email protected]>
Signed-off-by: M. Fatih Cırıt <[email protected]>
docs/contributing/coding-guidelines/ros-nodes/directory-structure.md
Outdated
Show resolved
Hide resolved
docs/contributing/coding-guidelines/ros-nodes/directory-structure.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for updating. I felt the rules were too strict in some parts. I think it would be nice if the maintainer could have a little more freedom in designing the inside of the package.
docs/contributing/coding-guidelines/ros-nodes/directory-structure.md
Outdated
Show resolved
Hide resolved
Signed-off-by: M. Fatih Cırıt <[email protected]>
Signed-off-by: M. Fatih Cırıt <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@xmfcx thanks for writing this up. I'd go a bit further and make all this mandatory (i.e. not should, but must). The more uniform the packages are, the easier they'll be to read, debug and fix issues.
Signed-off-by: M. Fatih Cırıt <[email protected]>
docs/contributing/coding-guidelines/ros-nodes/directory-structure.md
Outdated
Show resolved
Hide resolved
Signed-off-by: M. Fatih Cırıt <[email protected]>
Signed-off-by: Takagi, Isamu <[email protected]>
Signed-off-by: M. Fatih Cırıt <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@xmfcx LGTM, thanks for addressing my feedback.
Thanks everyone for your reviews! I will merge this as 4 developers have reviewed it already. If anyone wants to change some part of it, they can open a new PR. |
Description
Previous discussions:
As we are prefixing the packages with
autoware_
, we needed to clear the rules to avoid confusion.Using or omitting the
autoware_
prefix or_node
suffix can be highly confusing without clear guidelines.Pre-review checklist for the PR author
The PR author must check the checkboxes below when creating the PR.
In-review checklist for the PR reviewers
The Reviewers must check the checkboxes below before approval.
Post-review checklist for the PR author
The PR author must check the checkboxes below before merging.
After all checkboxes are checked, anyone who has write access can merge the PR.