Skip to content
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

Merged
merged 13 commits into from
May 9, 2024

Conversation

xmfcx
Copy link
Contributor

@xmfcx xmfcx commented May 8, 2024

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.

  • There are no open discussions or they are tracked via tickets.

After all checkboxes are checked, anyone who has write access can merge the PR.

@xmfcx xmfcx added the tag:deploy-docs Mark for deploy-docs action generation. (used-by-ci) label May 8, 2024
@xmfcx xmfcx self-assigned this May 8, 2024
Signed-off-by: M. Fatih Cırıt <[email protected]>
xmfcx added 2 commits May 9, 2024 11:16
Signed-off-by: M. Fatih Cırıt <[email protected]>
Copy link
Contributor

@isamu-takagi isamu-takagi left a 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.

xmfcx added 2 commits May 9, 2024 12:01
Signed-off-by: M. Fatih Cırıt <[email protected]>
Signed-off-by: M. Fatih Cırıt <[email protected]>
Copy link
Contributor

@esteve esteve left a 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.

xmfcx and others added 2 commits May 9, 2024 13:01
Signed-off-by: M. Fatih Cırıt <[email protected]>
Signed-off-by: M. Fatih Cırıt <[email protected]>
@xmfcx xmfcx requested a review from esteve May 9, 2024 11:33
Copy link
Contributor

@esteve esteve left a 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.

@xmfcx
Copy link
Contributor Author

xmfcx commented May 9, 2024

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.

@xmfcx xmfcx merged commit a1720f4 into main May 9, 2024
8 of 9 checks passed
@xmfcx xmfcx deleted the feat/naming-guidelines branch May 9, 2024 12:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tag:deploy-docs Mark for deploy-docs action generation. (used-by-ci)
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants